X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/5e91ffa48a236197b639e2fbca1566986d0e0608..21e65e7907cc8d34acda8e7adb464087075f577b:/README.md?ds=sidebyside

diff --git a/README.md b/README.md
index f80acef..8700b94 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,27 @@
 # About
-[Uguu.se](http://uguu.se) source code, stores files and deletes after 1 hour.
+[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 and Apache (PHP 5.4) on Ubuntu 14.04 LTS
+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` 
+* Some extensions are blocked by default, this can be changed via includes/core.php's $block array.
+* Everything else to your likings.
 
 Change php.ini and nginx.conf settings to allow bigger uploads.
 
-Make the rain/cache/ directory writable to whatever webserver you use.
+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).
+* Respond with JSON rather then a white page with echo, will break current tools for the page tho, maybe add a switch so using the webpage will respond using JSON by default and using the 'API' will respond with a plain echo by default?
+* Probably a lot of things but I'm a lazy fuck, come with suggestions.
 
 
 # Using the API
@@ -24,6 +33,14 @@ Proper design, commit new design and updated code (when finished, in preview pha
   
   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).
+  
+  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)
 
 
 This will probably get changed later since it's messy and unpractical.