Add description

[perso/Immae/Projets/Nodejs/Surfer.git] / DESCRIPTION.md

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]
+