From a3652a772d1a05be3e9b4b914ee8660e23189cf9 Mon Sep 17 00:00:00 2001 From: Graham Steffaniak Date: Sun, 30 Jul 2023 17:40:59 -0500 Subject: [PATCH] updated readme --- README.md | 35 ++++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8d4a5b0b..41b8776a 100644 --- a/README.md +++ b/README.md @@ -8,20 +8,26 @@ This fork makes the following significant changes to filebrowser for origin: - [x] Lightning fast - [x] Realtime results as you type - [x] Works with file type filter + - [x] better desktop search view 1. [ ] Preview enhancements - - preview default view is constrained to files subwindow, + - Preview default view is constrained to files subwindow, which can be toggled to fullscreen. - 1. Improved and simplified GUI - - + 1. [x] Improved and simplified GUI + - Moved all action buttons to file action bar except for switch-view + - Simplified navbar to 3 main actions: settings,search, and switch-view 1. [x] Updated version and dependencies - - [x] uses latest npm and node version - - [x] removes deprecated npm packages + - [x] Uses latest npm and node version + - [x] Removes deprecated npm packages - [x] Updates golang dependencies - 1. [ ] Moved all configurations to filebrowser.json. no more flags or binary operations to db + 1. [ ] Moved all configurations to filebrowser.json. + no more flags or binary operations to db ## About -Filebrowser provides a file managing interface within a specified directory and it can be used to upload, delete, preview, rename and edit your files. It allows the creation of multiple users and each user can have its own directory. It can be used as a standalone app. +Filebrowser provides a file managing interface within a specified directory +and it can be used to upload, delete, preview, rename and edit your files. +It allows the creation of multiple users and each user can have its own +directory. It can be used as a standalone app. ## Install @@ -30,7 +36,7 @@ Using docker: 1. docker run: ``` -docker run -it -v /path/to/folder:/srv -p 8080:80 gtstef/filebrowser:0.1.0 +docker run -it -v /path/to/folder:/srv -p 8080:80 gtstef/filebrowser:0.1.3 ``` 1. docker-compose: @@ -47,7 +53,7 @@ services: - './config.json:/.filebrowser.json' ports: - '8080:80' - image: gtstef/filebrowser:0.1.0 + image: gtstef/filebrowser:0.1.3 ``` - with network share @@ -62,7 +68,7 @@ services: #- './config.json:/.filebrowser.json' ports: - '8080:80' - image: gtstef/filebrowser:0.1.0 + image: gtstef/filebrowser:0.1.3 volumes: nas: driver_opts: @@ -73,9 +79,12 @@ volumes: ## Configuration -All configuration is now done via the filebrowser.json config file. This was chosen because it works best with a docker first use case. +All configuration is now done via the filebrowser.json config file. +This was chosen because it works best with a docker first use case. -Previously the primary way to configure filebrowser was via flags. But this quickly became cumbersome if you had many configurations to make +Previously the primary way to configure filebrowser was via flags. +But this quickly became cumbersome if you had many configurations to make -The other method to configure was via `filebrowser config` commands which would write configurations to a db if it existed already. +The other method to configure was via `filebrowser config` commands which +would write configurations to a db if it existed already. When considering \ No newline at end of file