X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/66809aeb45a7712fc8312057a8435cc5498a70ee..HEAD:/README.md

diff --git a/README.md b/README.md
index 5fec99f..e3144f0 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,71 @@
-# About
-[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
+# Uguu
 
-# Install
-Tested with:
-* Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy 
-* Apache (PHP 5.4) on Ubuntu 14.04 LTS
-* Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
+[![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)
 
-Modify 
-* core.php on where to save the files (line 4) and the prepend to the uploaded URL (line 26)
-* Cron with check.sh: `crontab -e` 
-* Everything else to your likings.
+# What is Uguu?
 
-Change php.ini and nginx.conf settings to allow bigger uploads.
+Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
 
-Make the uguu/ directory modifiable to the nginx user:
-`setfacl -m u:www-data:rwx /path/to/uguu/directory/`
+## Features
 
-# Todo
+- 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.
 
-Proper design, commit new design and updated code (when finished, in preview phase).
+### Demo
 
+See the real world site at [uguu.se](https://uguu.se).
 
-# Using the API
+## Requirements
 
-  Be sure to set a user agent, otherwise CF might reject you as malicious.
+Tested and working with Nginx + PHP-8.1 + SQLite/MySQL/PostgreSQL.
 
-  Leaving POST value 'name' empty will cause it to save using the original filename.
-  Leaving POST value 'randomname' empty will cause it to use original filename or custom name if 'name' is set to file.ext.
-  
-  Putting anything into POST value 'randomname' will cause it to return a random filename + ext (xxxxxx.ext).
-  Putting a custom name into POST value 'name' will cause it to return a custom filename (yourpick.ext).
+Node is used to compile Uguu, after that it runs on PHP.
 
+## Installation
 
-This will probably get changed later since it's messy and unpractical.
+Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
 
-# Contact
+If you need a admin panel check out [Moe Panel](https://github.com/Pomf/MoePanel).
 
-[neku@pomf.se](mailto:neku@pomf.se) or [@Nekunekus](https://twitter.com/nekunekus).
+## 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 & Go Johansson (nekunekus) and with help from the open source community.
+
+## License
+
+Uguu is free software, and is released under the terms of the GPL-3.0 license. See
+`LICENSE`.