Update README.md

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 1c763e120e12c85f50866dac568de5fc7b88cfb5..eb73ae570e509ef62785fcfd73330c3f82ba0f57 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
 # Uguu
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
-[![MIT
-licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nokonoko/uguu/master/LICENSE)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se)
 
 
@@ -27,8 +26,8 @@ See the real world site at [uguu.se](https://uguu.se).
 
 ## Requirements
 
-Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
-work with Apache 2.4 and newer PHP versions like PHP7.3 and PHP8.0
+Original development environment is Nginx + PHP8.1 + SQLite, but is confirmed to
+work with Apache and older PHP versions like PHP7.4.
 
 Node is used to compile Uguu.
 
@@ -42,6 +41,17 @@ If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel
 
 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.