X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/d0cf9b3df0a3fc97a7ae7eb33866bc5e77fc3d18..06790f5ce6082ab0a75ba206bfffa0b1e50c7d73:/README.md

diff --git a/README.md b/README.md
index 9daab41..c83e4f2 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,61 @@
-# About
-Temp file sharing application source code, stores files and deletes after X amount of time. Forked from Uguu.se available [here](https://github.com/nokonoko/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)
 
-# Install
-Tested with:
-* Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy
-* Apache (PHP 5.4) on Ubuntu 14.04 LTS
-* Apache (PHP 5.6) on Debian 8 Jessie
-* Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
 
-Modify
-* Modify includes/config.php (copy config.template.php as a starting point) to determine the path and URL to the app, the default retention time and other config points
-* Execute check.sh with cron to delete old files: `crontab -e` and add `0,15,30,45 * * * * bash /path/to/check.sh` (or adapt if you know how cron works).
-* Some extensions are blocked by default, this can be changed via includes/config.php's CONFIG_BLOCKED_EXTENSIONS value.
+# What is Uguu?
 
-Make the uguu/public/files and uguu/rain/cache directory modifiable to the web server user:
-`chown -R www-data:www-data /path/to/uguu/public/files` and `chown -R www-data:www-data /path/to/uguu/rain/cache`
+Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
 
-# Using the API
+## Features
 
-  * 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.
+- 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
 
-  * 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).
+### Demo
 
-  E.g:
-  * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload (HTML Response)
-  * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload-tool (Plain text Response)
+See the real world site at [uguu.se](https://uguu.se).
+
+## Requirements
+
+Tested and working with Nginx + PHP-8.0/8.1 + SQLite/MySQL. 
+
+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).
+
+## 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 & 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`.