Commit d56e255f by Girish Ramakrishnan

Add README.md

1 parent 8f9e3c71
Showing with 44 additions and 0 deletions
# 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]
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!