Skip to content

Commit 60ddc0f

Browse files
committed
Add README
1 parent 08ea80c commit 60ddc0f

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# CustomGento_Invoice (Magento 2)
2+
This extension extends the default Magento 2 purchase order payment method by a customer group and admin filter.
3+
4+
## Description
5+
This extension for Magento 2 extends the default purchase order payment method by two new configuration options:
6+
7+
* Define that the payment method should only be available for specific customer groups.
8+
* Define that the payment method should only be available in the backend.
9+
10+
## Compatibility
11+
* Magento >= 2.3.3
12+
13+
## Installation Instructions
14+
The installation procedure highly depends on your setup. In any case, you should use a version control system like git and test the installation on a development system.
15+
16+
### Composer Installation
17+
1. `composer require customgento/module-invoice-m2`
18+
2. `bin/magento module:enable CustomGento_Invoice`
19+
3. `bin/magento setup:upgrade`
20+
4. `bin/magento setup:di:compile`
21+
5. `bin/magento cache:flush`
22+
23+
### Manual Installation
24+
1. unzip the downloaded files
25+
2. create the directory `app/code/CustomGento/Invoice/`: `mkdir -p app/code/CustomGento/Invoice/`
26+
3. copy the unzipped files to the newly created directory `app/code/CustomGento/Invoice/`
27+
4. `bin/magento module:enable CustomGento_Invoice`
28+
5. `bin/magento setup:upgrade`
29+
6. `bin/magento setup:di:compile`
30+
7. `bin/magento cache:flush`
31+
32+
## Uninstallation
33+
The installation procedure depends on your setup:
34+
35+
### Uninstallation After Composer Installation
36+
1. `bin/magento module:uninstall CustomGento_Invoice`
37+
2. `bin/magento setup:di:compile`
38+
3. `bin/magento cache:flush`
39+
40+
### Uninstallation After Manual Installation
41+
1. `bin/magento module:disable CustomGento_Invoice`
42+
2. `bin/magento setup:di:compile`
43+
3. `bin/magento cache:flush`
44+
4. `rm -r app/code/CustomGento/Invoice`
45+
46+
## Support
47+
If you have any issues with this extension, feel free to [open an issue on GitHub](https://github.com/customgento/CustomGento_Invoice-m2/issues).
48+
49+
## Licence
50+
[Open Software License 3.0](https://opensource.org/licenses/OSL-3.0)
51+
52+
## Copyright
53+
(c) 2018-2020 CustomGento / Simon Sprankel

0 commit comments

Comments
 (0)