Update README.md

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 5fec99faba40186c2d3876524acbf71f422b9bac..b71c41d3b1af894921694e5d6e070e67a9e0cbe3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,8 +8,11 @@ Tested with:
 * Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
 
 Modify 
-* core.php on where to save the files (line 4) and the prepend to the uploaded URL (line 26)
+* Modify includes/core.php where to save files and other paths.
+* Set correct paths in several other files. (Will add fix for this via config file instead).
+* Change uguu.se to your own name in several files.
 * 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.
@@ -19,7 +22,9 @@ Make the uguu/ directory modifiable to the nginx user:
 
 # Todo
 
-Proper design, commit new design and updated code (when finished, in preview phase).
+* Restructure files.
+* Make global config file.
+* Probably a lot of things but I'm a lazy fuck, come with suggestions.
 
 
 # Using the API
@@ -31,6 +36,12 @@ 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.