updated documentation and install instructions

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 3a61f7d79288336a873634ae27f4b41770c745c0..4f08d8978bdd859b7f24f8bc7c1819f227f2974d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,29 +1,56 @@
-# About
-[Uguu.se](http://uguu.se) source code, stores files and deletes after 1 hour.
+# What is Uguu?
 
-# Install
-Tested with Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy.
+Uguu is a simple lightweight temporary file uploading and sharing platform where files get deleted after X amount of time.
 
-Modify core.php where to save the files, add check.sh to Cron, edit everything else to your likings.
+## Features
 
-Change php.ini and nginx.conf settings to allow bigger uploads.
+- 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
 
-# Todo
+### Demo
 
-Proper design, commit new design and updated code (when finished, in preview phase).
+See the real world example at [uguu.se](https://uguu.se).
 
+## Requirements
 
-# Using the API
+Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
+work with Apache 2.4 and newer PHP versions like PHP7.3.
 
-  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).
+## Install
 
+A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
 
-This will probably get changed later since it's messy and unpractical.
+## 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)
+```
 
-# Contact
+## Getting help
 
-[neku@pomf.se](mailto:neku@pomf.se) or [@Nekunekus](https://twitter.com/nekunekus).
+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).
+
+## License
+
+Uguu is free software, and is released under the terms of the Expat license. See
+`LICENSE`.