]> jfr.im git - uguu.git/commitdiff
Update README.md
authorEric Johansson (neku) <redacted>
Wed, 11 Feb 2015 17:01:03 +0000 (18:01 +0100)
committerEric Johansson (neku) <redacted>
Wed, 11 Feb 2015 17:01:03 +0000 (18:01 +0100)
README.md

index 70d7b45edcd23c86e8047e469c94a51f4ef34599..e4d393e4675ae595927a9f5c89d106482d519396 100644 (file)
--- a/README.md
+++ b/README.md
@@ -11,3 +11,13 @@ Change php.ini and nginx.conf settings to allow bigger uploads.
 # Todo
 
 Proper design, commit new design and updated code (when finished, in preview phase).
+
+
+# Using the API
+
+For now you can use the API like so:
+  Leaving POST value 'name' empty will cause it to save using the original filename.
+  Leaving POST valie '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).