diff options
Diffstat (limited to 'DESCRIPTION.md')
-rw-r--r-- | DESCRIPTION.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/DESCRIPTION.md b/DESCRIPTION.md index 4b35e46..462336a 100644 --- a/DESCRIPTION.md +++ b/DESCRIPTION.md | |||
@@ -1,9 +1,14 @@ | |||
1 | Surfer is a Simple static file server. It comes with a commandline tool | 1 | Surfer is a Simple static file server. It comes with a webinterface and commandline tooling to manage files. |
2 | to upload files from your local folders. | ||
3 | 2 | ||
4 | ### How to upload | 3 | Any `index.html` file in a directory will be served up automatically. |
5 | 4 | ||
6 | You can upload files using the commandline tool. | 5 | ### Webinterface |
6 | |||
7 | * Upload files | ||
8 | * Create directories | ||
9 | * Remove files and directories | ||
10 | |||
11 | ### Commandline tool | ||
7 | 12 | ||
8 | First, install the surfer cli tool using npm. | 13 | First, install the surfer cli tool using npm. |
9 | 14 | ||
@@ -12,10 +17,9 @@ First, install the surfer cli tool using npm. | |||
12 | 17 | ||
13 | Login using your Cloudron credentials: | 18 | Login using your Cloudron credentials: |
14 | 19 | ||
15 | surfer login <this app's url> | 20 | surfer login <appurl> |
16 | 21 | ||
17 | 22 | ||
18 | Put some files: | 23 | Put some files: |
19 | 24 | ||
20 | surfer put [file] | 25 | surfer put [file] |
21 | |||