Merge branch 'master' of https://git.pomf.se/Pomf/uguu

[uguu.git] / README.md

diff --git a/README.md b/README.md
index eaec73736ae164f8259cefb0fa037a57e8336ff8..b0ab8986f22a44080d1f44bab4d4cbc13e4bf858 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,21 +26,31 @@ See the real world site at [uguu.se](https://uguu.se).
 
 ## Requirements
 
-Original development environment is Nginx + PHP8.1 + SQLite, but is confirmed to
-work with Apache and older PHP versions like PHP7.4.
+Tested and working with Nginx + PHP-8.0/8.1 + SQLite/MySQL. 
 
-Node is used to compile Uguu.
+Node is used to compile Uguu, after that it runs on PHP.
 
 ## Installation
 
 Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
 
-If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel).
+If you need a admin panel check out [Moe Panel](https://git.pomf.se/Pomf/MoePanel).
 
 ## Getting help
 
 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
 
+## Contributing
+
+We'd really like if you can take some time to make sure your coding style is
+consistent with the project. Uguu follows [PHP
+PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript
+(ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`)
+coding style guides. We use ESLint and PHPCS tools to enforce these standards.
+
+You can also help by sending us feature requests or writing documentation and
+tests.
+
 ## Credits
 
 Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community.