X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/68c573a695351b4b74e6dd1b87a88c0d91f4c76c..b318cf67eb590625259068eeaafddb25de7881de:/README.md

diff --git a/README.md b/README.md
index b859095..4f08d89 100644
--- a/README.md
+++ b/README.md
@@ -1,54 +1,56 @@
-# About
-[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
+# What is Uguu?
 
-# 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
+Uguu is a simple lightweight temporary file uploading and sharing platform where files get deleted after X amount of time.
 
-# Install:
+## Features
 
-* Deploy base code, for example with `git clone https://github.com/nokonoko/Uguu.git`
-* Modify includes/config.php (copy config.template.php as a starting point) to set up the main options for Uguu.
-* Some file extensions are blocked by default, this can be changed via includes/config.php's CONFIG_BLOCKED_EXTENSIONS value.
-* Copy `rain/template/footer.template.html` as `rain/template/footer.html` and personalize the footer as you wish
-* Execute check.sh regularly 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).
-* Make the Uguu/public/files and Uguu/rain/cache directory modifiable by 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`
-* Make sure the Uguu/public/files folder is not indexable, you may use a virtual host config similar to this one:
+- 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
 
-```
-<VirtualHost *:80>
-        ServerName path.to.uguu
+### Demo
+
+See the real world example at [uguu.se](https://uguu.se).
+
+## Requirements
+
+Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
+work with Apache 2.4 and newer PHP versions like PHP7.3.
 
-        DocumentRoot /var/www/Uguu/
-        <Directory /var/www/Uguu/>
-                AllowOverride All
-                Require all granted
-        </Directory>
+## Install
 
-        Alias "/files" "/var/www/Uguu/public/files/"
-        <Directory /var/www/Uguu/public/files/>
-		<Files *>
-                        SetHandler default-handler
-                </Files>
-                AllowOverride None
-                Options -Indexes
-                Require all granted
-        </Directory>
+A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
 
-</VirtualHost>
+## 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)
+```
+
+## Getting help
+
+Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
 
-# Using the API
+## Credits
 
-  * 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.
+Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus).
 
-  * 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).
+## License
 
-  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)
+Uguu is free software, and is released under the terms of the Expat license. See
+`LICENSE`.