From 2f8c12773bdfc81de3c0e34a00fd3c82adeb8a8c Mon Sep 17 00:00:00 2001 From: Pierre Dubouilh Date: Sat, 9 Feb 2019 16:00:34 +0100 Subject: [PATCH] readme --- .gitignore | 1 + readme.md | 45 ++++++++++++++++++++++----------------------- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/.gitignore b/.gitignore index e492ec2..fc8c347 100755 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ gossa-linux-arm gossa-linux-arm64 gossa-mac gossa-windows.exe +gossa_test.go .vscode fixture/* diff --git a/readme.md b/readme.md index 466ed85..6ff4183 100644 --- a/readme.md +++ b/readme.md @@ -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). @@ -28,33 +29,31 @@ make ./gossa -h 192.168.100.33 ~/storage ``` -### 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)| -|\ | 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 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 + 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| +|\ | 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