From: s-ko <aleks@s-ko.net>
Date: Sun, 21 Sep 2014 20:20:58 +0000 (+0100)
Subject: :memo: Added README
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=747589b85a464f83b8eb6fd36001e046bf6b7769;p=simple-upload.git

:memo: Added README
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d5bd4d2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Simple PHP upload
+
+Simple single-file PHP file upload (file share hosting) script.
+
+> :warning: **Security warning**: There is no limit on file size or file type. Please make sure that file permissions are set right so nobody can execute uploaded executables. Or exscape your desired directory!
+
+## Installation
+
+Just drop a PHP file in any directory. It will work straight away
+
+## Configuration
+
+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