From fddf8a29f8e50cf8c2abbe913ce905b24d8613d3 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Wed, 19 Jul 2017 08:46:45 +0100 Subject: [PATCH] Update README.md Former-commit-id: 62308763cd797b1399be6bb3eeda1cacb82cb2ce [formerly cdb67249c235a9306e4aa548562e8375a961bec7] [formerly 8042f4af72562c36910919936cf5165b927caa54 [formerly 65865237c28b5ae1e4a16ce1a023ec9b0e54c86a]] Former-commit-id: 095fa6256c456dda4e069a6d3e16a61fe175a1d6 [formerly 71a8877184a87dc905fde4355ed73e165f4545be] Former-commit-id: 9f7e7f827c5671cb663da4b52965dbe1a191bb02 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 3c6bbcfe..de6ed15d 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ filemanager provides a file managing interface within a specified directory and + [Features](#features) - [Users](#users) - [Search](#search) ++ [Contributing](#contributing) # Getting started @@ -66,3 +67,15 @@ By default, every search will be case sensitive. Although, you can make a case i ``` this are keywords case:insensitive ``` + +# Contributing + +If you want to contribute or want to build the code from source, you will need to have NodeJS and Go installed on your computer. You should start by doing the following: + +``` +go get github.com/hacdias/filemanager +``` + +Then, you should navigate to `$GOPATH/src/github.com/hacdias/filemanager` and execute `npm install`. You can start the live build of static assets with the command `npm start dev`. + +If you are using this as a Caddy plugin, you should use its [official instructions for plugins](https://github.com/mholt/caddy/wiki/Extending-Caddy#2-plug-in-your-plugin) and import `github.com/hacdias/filemanager/caddy/filemanager`.