Make listen port and ldap filter more flexible

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

diff --git a/DESCRIPTION.md b/DESCRIPTION.md
index 4b35e468cf896ed22bf0b129974755ead3d452e6..e7baecd5752a0fc4c254ff7787ab94aeb3bac2e3 100644 (file)
--- a/DESCRIPTION.md
+++ b/DESCRIPTION.md
@@ -1,9 +1,18 @@
-Surfer is a Simple static file server. It comes with a commandline tool
-to upload files from your local folders.
+This app packages Surfer <upstream>5.10.0</upstream>
 
-### How to upload
+### Overview
 
-You can upload files using the commandline tool.
+Surfer is a Simple static file server. It comes with a webinterface and commandline tooling to manage files.
+
+Any `index.html` file in a directory will be served up automatically.
+
+### Webinterface
+
+ * Upload files
+ * Create directories
+ * Remove files and directories
+
+### Commandline tool
 
 First, install the surfer cli tool using npm.
 
@@ -12,10 +21,9 @@ First, install the surfer cli tool using npm.
 
 Login using your Cloudron credentials:
 
-    surfer login <this app's url>
+    surfer login <appurl>
 
 
 Put some files:
 
     surfer put [file]
-