Update README.md

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 4f08d8978bdd859b7f24f8bc7c1819f227f2974d..eb73ae570e509ef62785fcfd73330c3f82ba0f57 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,18 @@
+# Uguu
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
+[![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)
+
+
 # What is Uguu?
 
-Uguu is a simple lightweight temporary file uploading and sharing platform where files get deleted after X amount of time.
+Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
 
 ## Features
 
 - One click uploading, no registration required
 - A minimal, modern web interface
-- Drag & drop supported
+- Drag & Drop & Paste supported
 - Upload API with multiple response choices
   - JSON
   - HTML
@@ -16,41 +22,41 @@ Uguu is a simple lightweight temporary file uploading and sharing platform where
 
 ### Demo
 
-See the real world example at [uguu.se](https://uguu.se).
+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.
+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.
 
-## Install
+## Installation
 
-A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
+Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
 
-## API
-To upload using curl or make a tool you can post using: 
-```
-curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
-```
-```
-curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response)
-```
-```
-curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response)
-```
-```
-curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response)
-```
+If you need a admin panel check out [Moe Panel](https://github.com/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).
+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.
 
 ## License
 
-Uguu is free software, and is released under the terms of the Expat license. See
+Uguu is free software, and is released under the terms of the GPL-3.0 license. See
 `LICENSE`.