Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
magefan authored Sep 14, 2017
1 parent 963ae16 commit 5b66c97
Showing 1 changed file with 45 additions and 2 deletions.
47 changes: 45 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,45 @@
# module-notifications
Notify the Magento 2 admin user about disabled caches or new customer reviews.
# [Magento 2 Notifications Extension](https://magefan.com/) by Magefan

This Magento 2 Notification module allows you to receive notifications in admin panel once review is pending for moderation or cache is disabled.

## Features
* Disabled Cache notifications
* Pending Customer Review notifications

## Requirements
* Magento Community Edition 2.1.x-2.2.x or Magento Enterprise Edition 2.1.x-2.2.x

## Installation Method 1 - Installing via composer
* Open command line
* Using command "cd" navigate to your magento2 root directory
* Run command: composer require magefan/module-notifications



## Installation Method 2 - Installing using archive
* Download [ZIP Archive](https://github.com/magefan/module-notifications/archive/master.zip)
* Extract files
* In your Magento 2 root directory create folder app/code/Magefan/Notifications
* Copy files and folders from archive to that folder
* In command line, using "cd", navigate to your Magento 2 root directory
* Run commands:
```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```

## Support
If you have any issues, please [contact us](mailto:support@magefan.com)
then if you still need help, open a bug report in GitHub's
[issue tracker](https://github.com/magefan/module-notifications/issues).

Please do not use Magento Marketplace Reviews or (especially) the Q&A for support.
There isn't a way for us to reply to reviews and the Q&A moderation is very slow.

## Need More Features?
Please contact us to get a quote
https://magefan.com/contact

## License
The code is licensed under [Open Software License ("OSL") v. 3.0](http://opensource.org/licenses/osl-3.0.php).

0 comments on commit 5b66c97

Please sign in to comment.