From 9e6cec9ae53f19b5d29712d994f0d23ce6a119fd Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Tue, 18 Jul 2017 21:50:32 +0100 Subject: [PATCH] Update README.md Former-commit-id: 2c811f8ccdfaa49105691e6eab3e0456c5316bec [formerly c43eca29df71d40f7f4c1af54d4d446e333eaaed] [formerly a00e86d20b8937a5389a315918549a46ddb4a761 [formerly d3c632aa1ad92ebfdf7b6ac6b11a01522bf86c80]] Former-commit-id: 0ce4f1de5a04d2345ad2d3933485f3efec35ffbc [formerly 7224104c098901ed248ea5807cbe5241dc464dff] Former-commit-id: 50e662ac3732e4681012ee22f684af333b7e3891 --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0fde256c..939d7153 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,30 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/hacdias/filemanager?style=flat-square)](https://goreportcard.com/report/hacdias/filemanager) [![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/hacdias/filemanager) +filemanager 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 or as a middleware. -## About Search +# Features + +Easy login system. + +![Login Page](https://user-images.githubusercontent.com/5447088/28327862-931bb42a-6bdc-11e7-8157-93fa54945f3c.png) + +Listings of your files, available in two styles: mosaic and list. You can delete, move, rename, upload and create new files, as well as directories. Single files can be downloaded directly, and multiple files as *.zip*, *.tar*, *.tar.gz*, *.tar.bz2* or *.tar.xz*. + +![Mosaic Listing](https://user-images.githubusercontent.com/5447088/28327863-931fe414-6bdc-11e7-91fb-49b5f15a829f.png) + +File Manager editor is powered by [Codemirror](https://codemirror.net/) and if you're working with markdown files with metadata, both parts will be separated from each other so you can focus on the content. + +![Markdown Editor](https://user-images.githubusercontent.com/5447088/28327865-933abc3a-6bdc-11e7-8f80-f206cf5cdf0b.png) + +On the settings page, a regular user can set its own custom CSS to personalize the experience and change its password. For admins, they can manage the permissions of each user, set commands which can be executed when certain events are triggered (such as before saving and after saving) and change plugin's settings. + +![Settings](https://user-images.githubusercontent.com/5447088/28327864-9325d716-6bdc-11e7-9de2-78953e6efdbe.png) + +We also allow the users to search in the directories and execute commands if allowed. + + +## Search FileManager allows you to search through your files and it has some options. By default, your search will be something like this: @@ -25,4 +47,4 @@ By default, every search will be case sensitive. Although, you can make a case i ``` this are keywords case:insensitive -``` \ No newline at end of file +```