first commit

modules/productcomments/README.md

@@ -0,0 +1,42 @@
+# Product Comments
+
+## About
+
+Allow users to post reviews on your products and/or rate them based on specific criteria.
+
+## Multistore compatibility
+
+This module is partially compatible with the multistore feature. Some of its options might not be available.
+
+### Update dependency
+
+The only dependency for this module (for now) is https://github.com/flaviusmatis/simplePagination.js.git
+You can install/update it by launching the command
+
+```
+# yarn install
+```
+
+(We use yarn because this library is not served as a package for npm).
+
+This will install the library js in views/js folder.
+
+## Reporting issues
+
+You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue]. 
+
+## Contributing
+
+PrestaShop modules are open source extensions to the [PrestaShop e-commerce platform][prestashop]. Everyone is welcome and even encouraged to contribute with their own improvements!
+
+Just make sure to follow our [contribution guidelines][contribution-guidelines].
+
+## License
+
+This module is released under the [Academic Free License 3.0][AFL-3.0] 
+
+[report-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose
+[prestashop]: https://www.prestashop.com/
+[contribution-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/
+[AFL-3.0]: https://opensource.org/licenses/AFL-3.0
+