X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/55177426c0b02225fb24ff5af79774ca41522086..HEAD:/README.md?ds=sidebyside

diff --git a/README.md b/README.md
index a61acbc..e3144f0 100644
--- a/README.md
+++ b/README.md
@@ -1,63 +1,71 @@
-# What is Uguu?
+# 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)
 
-Uguu is a simple lightweight temporary file hosting platform where files get deleted after X amount of time.
+# What is Uguu?
 
-It can also be configurated to not expire files, and act as a slimmed version of Pomf.
+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
-- Upload API with multiple response choices
-  - JSON
-  - HTML
-  - Text
-  - CSV
-- Supports [ShareX](https://getsharex.com/) and other screenshot tools
+- One click uploading, no registration required.
+- A minimal, modern web interface.
+- Drag & Drop & Paste supported.
+- Upload API with multiple response choices:
+    - JSON
+    - HTML
+    - Text
+    - CSV
+- Supports [ShareX](https://getsharex.com/) and other screenshot tools.
+- File extension & MIME black/whitelisting.
+- Upload rate limiting.
+- File (hash) blacklisting.
+- Run bare or as a container.
 
 ### 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.
+Tested and working with Nginx + PHP-8.1 + SQLite/MySQL/PostgreSQL.
 
-## Install
+Node is used to compile Uguu, after that it runs on PHP.
 
-A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
+## Installation
 
-## 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)
-```
+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).
 
 ## 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.
+
+## Upcoming Features
+
+* S3 Bucket Support
+* Azure File Storage Support
+* Temporal/RR Support
+
 ## 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.
+Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Go 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`.
-
-## To do in release v1.1.0
-* Mod feature and interface
-* Blacklist DB (already exists on Uguu.se, but not in this code)
-* Code cleanup