Change to readme

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 70d7b45edcd23c86e8047e469c94a51f4ef34599..5fec99faba40186c2d3876524acbf71f422b9bac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,40 @@
 # About
-Uguu.se source code, stores files and deletes after 30 minutes.
+[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
 
 # Install
-Tested with Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy.
+Tested with:
+* Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy 
+* Apache (PHP 5.4) on Ubuntu 14.04 LTS
+* Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
 
-Modify core.php where to save the files, add check.sh to Cron, edit everything else to your likings.
+Modify 
+* core.php on where to save the files (line 4) and the prepend to the uploaded URL (line 26)
+* Cron with check.sh: `crontab -e` 
+* Everything else to your likings.
 
 Change php.ini and nginx.conf settings to allow bigger uploads.
 
+Make the uguu/ directory modifiable to the nginx user:
+`setfacl -m u:www-data:rwx /path/to/uguu/directory/`
+
 # Todo
 
 Proper design, commit new design and updated code (when finished, in preview phase).
+
+
+# Using the API
+
+  Be sure to set a user agent, otherwise CF might reject you as malicious.
+
+  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).
+
+
+This will probably get changed later since it's messy and unpractical.
+
+# Contact
+
+[neku@pomf.se](mailto:neku@pomf.se) or [@Nekunekus](https://twitter.com/nekunekus).