Update README.md

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 932fa73064ba0086c707f4499ecd5979a53bc01c..470dbd5a29ddcbac68fe726915ac6be7e48ca139 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,52 @@
-# About
-Uguu.se source code, stores files and deletes after 30 minutes.
+# 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.
 
-Modify core.php where to save the files, add check.sh to Cron, edit 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.
 
-# Todo
+## Features
 
-Proper design, commit new design and updated code (when finished, in preview phase).
+- 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
 
+### Demo
 
-# Using the API
+See the real world site at [uguu.se](https://uguu.se).
 
-  Leaving POST value 'name' empty will cause it to save using the original filename.
-  Leaving POST valie '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).
+## Requirements
+
+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.
+
+## 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
+
+## 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 GPL-3.0 license. See
+`LICENSE`.