Skip to content

Commit 5b66c97

Browse files
authored
Update README.md
1 parent 963ae16 commit 5b66c97

File tree

1 file changed

+45
-2
lines changed

1 file changed

+45
-2
lines changed

README.md

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,45 @@
1-
# module-notifications
2-
Notify the Magento 2 admin user about disabled caches or new customer reviews.
1+
# [Magento 2 Notifications Extension](https://magefan.com/) by Magefan
2+
3+
This Magento 2 Notification module allows you to receive notifications in admin panel once review is pending for moderation or cache is disabled.
4+
5+
## Features
6+
* Disabled Cache notifications
7+
* Pending Customer Review notifications
8+
9+
## Requirements
10+
* Magento Community Edition 2.1.x-2.2.x or Magento Enterprise Edition 2.1.x-2.2.x
11+
12+
## Installation Method 1 - Installing via composer
13+
* Open command line
14+
* Using command "cd" navigate to your magento2 root directory
15+
* Run command: composer require magefan/module-notifications
16+
17+
18+
19+
## Installation Method 2 - Installing using archive
20+
* Download [ZIP Archive](https://github.com/magefan/module-notifications/archive/master.zip)
21+
* Extract files
22+
* In your Magento 2 root directory create folder app/code/Magefan/Notifications
23+
* Copy files and folders from archive to that folder
24+
* In command line, using "cd", navigate to your Magento 2 root directory
25+
* Run commands:
26+
```
27+
php bin/magento setup:upgrade
28+
php bin/magento setup:di:compile
29+
php bin/magento setup:static-content:deploy
30+
```
31+
32+
## Support
33+
If you have any issues, please [contact us](mailto:[email protected])
34+
then if you still need help, open a bug report in GitHub's
35+
[issue tracker](https://github.com/magefan/module-notifications/issues).
36+
37+
Please do not use Magento Marketplace Reviews or (especially) the Q&A for support.
38+
There isn't a way for us to reply to reviews and the Q&A moderation is very slow.
39+
40+
## Need More Features?
41+
Please contact us to get a quote
42+
https://magefan.com/contact
43+
44+
## License
45+
The code is licensed under [Open Software License ("OSL") v. 3.0](http://opensource.org/licenses/osl-3.0.php).

0 commit comments

Comments
 (0)