Add README.md

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b940258
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Surfer
+
+Surfer is a Simple static file server. It comes with a commandline tool
+to upload files from your local folders.
+
+## Installation
+
+[![Install](https://cloudron.io/img/button32.png)](https://cloudron.io/button.html?app=io.cloudron.surfer)
+
+or using the [Cloudron command line tooling](https://cloudron.io/references/cli.html)
+
+```
+cloudron install --appstore-id io.cloudron.surfer
+```
+
+## Building
+
+The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
+
+```
+cd surfer
+
+cloudron build
+cloudron install
+```
+
+### How to upload
+
+You can upload files using the commandline tool.
+
+First, install the surfer cli tool using npm.
+
+    sudo npm -g install cloudron-surfer
+
+
+Login using your Cloudron credentials:
+
+    surfer login <this app's url>
+
+
+Put some files:
+
+    surfer put [file]
+