Add description

diff --git a/CloudronManifest.json b/CloudronManifest.json
index f16fb62be321709375e48f8067642e8f97f701f5..47983647f5c68ed5e7d663115b3c46b835467dfc 100644 (file)
--- a/CloudronManifest.json
+++ b/CloudronManifest.json
@@ -2,7 +2,7 @@
   "id": "io.cloudron.surfer",
   "title": "Surfer",
   "author": "Cloudron Team",
-  "description": "Simple static file server. It comes with a commandline tool to upload files from your local folders.",
+  "description": "file://DESCRIPTION.md",
   "tagline": "Static file server",
   "tags": [
     "fileserver",

diff --git a/DESCRIPTION.md b/DESCRIPTION.md
new file mode 100644 (file)
index 0000000..4b35e46
--- /dev/null
+++ b/DESCRIPTION.md
@@ -0,0 +1,21 @@
+Surfer is a Simple static file server. It comes with a commandline tool
+to upload files from your local folders.
+
+### 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]
+