Update README.md

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 6a36173951839af76faeb56ba3b92e0de1fc28e4..0971123f773c05842b33888d28603712cfe140bd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +1,51 @@
-# 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)
+[![MIT
+licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nokonoko/uguu/master/LICENSE)
+[![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 file uploading and sharing platform, with the option for files to expire.
 
-# 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://uguu.se/api.php?d=upload (HTML Response)
-  * curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload-tool (Plain text Response)
+See the real world example at [uguu.se](https://uguu.se).
 
-This will probably get changed later since it's messy and unpractical.
+## Requirements
 
-# Contact
-[neku@pomf.se](mailto:neku@pomf.se) or [@Nekunekus](https://twitter.com/nekunekus).
+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
+
+Node is used to compile Uguu.
+
+## Installation
+
+Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
+
+
+## Getting help
+
+Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
+
+## 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.
+
+## License
+
+Uguu is free software, and is released under the terms of the Expat license. See
+`LICENSE`.