Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pldubouilh committed Feb 9, 2019
1 parent dbcda0f commit 2f8c127
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 21 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ gossa-linux-arm
gossa-linux-arm64
gossa-mac
gossa-windows.exe
gossa_test.go

.vscode
fixture/*
Expand Down
41 changes: 20 additions & 21 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
gossa
=============

![e](https://user-images.githubusercontent.com/760637/45410804-f2c00e80-b672-11e8-8c2b-51d7fc0915aa.gif)
![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)

🎶 A fast and simple webserver for your files, that's dependency-free and with under 210 lines for the server code, easily code-reviewable.

### features
* browse through files/directories
* upload with drag-and-drop
* move/rename/delete files
* browse through pictures with a full-screen carousel
* stream videos directly from the browser
* simple keyboard navigation/shortcuts
* fast ; fills my 80MB/s AC wifi link
* 🔍 files/directories browser
* 📩 drag-and-drop file uploader
* 🗺️ files handling - move/rename/delete
* 📸 picture browser
* 📽️ video streaming from the browser
* ✍️ simple text editor
* ⌨️ keyboard shortcuts
* 🥂 speed - showed rates above 100MB/s

### built blobs
built blobs are available on the [release page](https://github.com/pldubouilh/gossa/releases).
Expand All @@ -28,33 +29,31 @@ make
./gossa -h 192.168.100.33 ~/storage
```

### ui shortcuts
|shortcut | action|
| ------------- |-------------|
|click new folder icon | create new folder|
|click pad icon | open file editor|
|click file icon | rename item|
|double click file icon | delete item|
|drag-and-drop item on UI | move item|
|drag-and-drop external item | upload file/folders|

### keyboard shortcuts
|shortcut | action|
|-------------|-------------|
|Arrows/Enter | browse through files/directories and pictures|
|Ctrl/Meta + C | copy URL to clipboard|
|Ctrl/Meta + B | toggle theme (dark/clear)|
|\<any letter\> | search|
|Ctrl/Meta + E | rename file/folder|
|Ctrl/Meta + Del | delete file/folder|
|Ctrl/Meta + D | create a new directory|
|Ctrl/Meta + X | cut selected path|
|Ctrl/Meta + V | paste previously selected paths to directory|

### ui shortcuts
|shortcut | action|
| ------------- |-------------|
|click new folder icon | create new folder|
|click images icon | toggle image carousel|
|click file icon | rename item|
|double click file icon | delete item|
|drag-and-drop item on UI | move item|
|drag-and-drop external item | upload file/folders|
|\<any letter\> | search|

### using with docker
multiple dockerfiles are provided in the `docker` folder. to simply get started just have a look below


```sh
# build
cd docker
Expand Down

0 comments on commit 2f8c127

Please sign in to comment.