cleanup + readme

This commit is contained in:
Pierre Dubouilh
2019-06-30 12:59:03 +02:00
parent 776abdc35b
commit 0487600be7
7 changed files with 18 additions and 18 deletions
+12 -12
View File
@@ -3,11 +3,15 @@ gossa
![e](https://user-images.githubusercontent.com/760637/52522293-942fa880-2c83-11e9-9f79-0a5b922bcc7f.gif)
[![Build Status](https://travis-ci.org/pldubouilh/gossa.svg?branch=master)](https://travis-ci.org/pldubouilh/gossa)
[![build status](https://img.shields.io/travis/pldubouilh/gossa.svg?logo=travis)](https://travis-ci.org/pldubouilh/gossa)
[![docker build status](https://img.shields.io/docker/cloud/build/pldubouilh/gossa.svg?logo=docker)](https://hub.docker.com/r/pldubouilh/gossa)
[![docker pulls](https://img.shields.io/docker/pulls/pldubouilh/gossa.svg?logo=docker)](https://hub.docker.com/r/pldubouilh/gossa)
[![github downloads](https://img.shields.io/github/downloads/pldubouilh/gossa/total.svg?logo=github)](https://github.com/pldubouilh/gossa/releases)
🎶 A fast and simple webserver for your files, that's dependency-free and with under 210 lines for the server code, easily code-reviewable.
a fast and simple webserver for your files, that's dependency-free and with only 210 lines of code, easy to review.
a [simple UI](https://github.com/pldubouilh/gossa-ui) comes as default, featuring :
### features
* 🔍 files/directories browser
* 📩 drag-and-drop file/directory uploader
* 🗺️ files handling - move/rename/delete
@@ -17,16 +21,12 @@ gossa
* ⌨️ keyboard shortcuts
* 🥂 speed - showed rates above 100MB/s
### built blobs
built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases).
### build
built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases) - or simply `make build` this repo
### run
### usage
```sh
# build (or download release from github)
make
# run
./gossa -h 192.168.100.33 ~/storage
% ./gossa -h 192.168.100.33 ~/storage
```
### ui shortcuts
@@ -57,5 +57,5 @@ a few docker/docker-compose files are provided in the [docker folder](https://gi
```sh
# pull from dockerhub and run
sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa
% sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 pldubouilh/gossa
```