cleanup + readme

docker/readme.md

@@ -2,17 +2,17 @@ the master branch is automatically built and pushed to [dockerhub](https://hub.d
 
 ```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
 ```
 
 if you prefer building the image yourself :
 
 ```sh
 # build gossa within a build container, needs to be ran within the sources, ../ from here
-docker build -t gossa -f docker/build.Dockerfile .
+% docker build -t gossa -f docker/build.Dockerfile .
 
 # and to run it simply
-sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 gossa
+% sudo docker run -v ~/LocalDirToShare:/shared -p 8001:8001 gossa
 ```
 
 
@@ -20,10 +20,10 @@ a fancy docker image using [Caddy](https://caddyserver.com/) is also provided. a
 
 ```sh
 # run with caddy, checkout the config in the dockerfile
-docker build -t gossa -f caddy.Dockerfile .
+% docker build -t gossa -f caddy.Dockerfile .
 
 # run with caddy
-sudo docker run -v ~/LocalDirToShare:/shared --net=host gossa
+% sudo docker run -v ~/LocalDirToShare:/shared --net=host gossa
 ```
 
 a docker-compose example image is also provided. running docker compose should be straightforward : `docker-compose up .` have a look in `docker-compose.yml` for further configuration.

gossa-ui

@@ -1 +1 @@
-Subproject commit 79f7b527cb750c96a636b7809cb36ccbf8548850
+Subproject commit bbef5ebf9ddd0c34e0863213e2dac622c9d60c60

readme.md

@@ -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
+### build
-built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases).
+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)
+% ./gossa -h 192.168.100.33 ~/storage
-make
-
-# run
-./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
 ```