From 968821cc7a8dc38a924a61937ea96edd3b24ea5a Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Tue, 18 Jul 2017 21:59:47 +0100 Subject: [PATCH] Add Get Started section Former-commit-id: db4259b74f0e5deac4f7f4e33c6b70ee3fb84369 [formerly 56fbff690cf7e5a5b11273d4b52952dd477b81fe] [formerly e7df49594466e40cb91a301b4bf11fa082f2ffdc [formerly b9bf62a018e1e37fd9911016213056ba0e8d5105]] Former-commit-id: a72e5a33f9c2a3ee4f871c1b09e34d4570c98df8 [formerly fbd9e9ef2c558ece193e3c3d5fdef5573b6b1d60] Former-commit-id: 5cff6d3ee566141b20ca5f2100be711572b18ce4 --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 939d7153..73b473b6 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ 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. +# Getting started + +This is a library so it can be used on your own applications as a middleware or as a standalone app (examples are going to be added in the future). + +The easiest way to get started is using this with Caddy web server. You just need to download Caddy from its [official website](https://caddyserver.com/download) with `http.filemanager` plugin enabled. For more information about the plugin itself, please refer to its [documentation](https://caddyserver.com/docs/http.filemanager). + # Features Easy login system. @@ -26,6 +32,9 @@ On the settings page, a regular user can set its own custom CSS to personalize t We also allow the users to search in the directories and execute commands if allowed. +## Users + +![6](https://user-images.githubusercontent.com/5447088/28339269-7a6bab5c-6c03-11e7-9e58-64ead58fc95a.png) ## Search