:memo: Updated available options doc

[simple-upload.git] / README.md

diff --git a/README.md b/README.md
index d5bd4d2c4ea1bee8e432a5e2f0e44cc972ed828c..c0ad4449818d71cd6a3cc9ed0757289103e268d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -12,8 +12,58 @@ Just drop a PHP file in any directory. It will work straight away
 
 There are few options that you can change by editing the file itself:
 
-- `$settings['uploaddir'] = '.';`
-       Directory to store the uploaded files. Defaults to rurrect script directory
 
-- `$settings['listfiles'] = true;`
-       Option that will list all files in uploads directory. Enabled by default
+
+- Directory to store uploaded files
+
+       `uploaddir` => `'.'`
+
+- Display list uploaded files
+
+       `listfiles` => `true`
+
+- Allow users to delete files that they have uploaded (will enable sessions)
+
+       `allow_deletion` => `true`
+
+- Display file sizes
+
+       `listfiles_size` => `true`
+
+- Display file dates
+
+       `listfiles_date` => `true`
+
+- Display file dates format
+
+       `listfiles_date_format` => `'F d Y H:i:s'`
+
+- Randomize file names (number of 'false')
+
+       `random_name_len` => `4`
+
+- Keep filetype information (if random name is activated)
+
+       `random_name_keep_type` => `true`
+
+- Random file name letters
+
+       `random_name_alphabet` => `'qwertyuiopasdfghjklzxcvbnm'`
+
+- Display debugging information
+
+       `debug` => `($_SERVER['SERVER_NAME'] === 'localhost')`
+
+## Usage options
+
+- Through an interface:
+       - Choose files via dialogue
+       - Drop files, via HTML5 drag'and'drop (using [dropzone.js](http://www.dropzonejs.com/))
+       - Basic HTML Form (if no JavaScript is suported)
+- Upload using any compatible tool (like cURL)
+
+       This example will upload a file and copy URL to clipboard:
+
+       ```bash
+       curl -F "file=@file.jpg" your-host/sharing/ | xclip -sel clip
+       ```