Update README.md

Former-commit-id: 62308763cd797b1399be6bb3eeda1cacb82cb2ce [formerly cdb67249c235a9306e4aa548562e8375a961bec7] [formerly 8042f4af72562c36910919936cf5165b927caa54 [formerly 65865237c2]]
Former-commit-id: 095fa6256c456dda4e069a6d3e16a61fe175a1d6 [formerly 71a8877184a87dc905fde4355ed73e165f4545be]
Former-commit-id: 9f7e7f827c5671cb663da4b52965dbe1a191bb02
pull/726/head
Henrique Dias 2017-07-19 08:46:45 +01:00 committed by GitHub
parent cf84731b0a
commit fddf8a29f8
1 changed files with 13 additions and 0 deletions

View File

@ -12,6 +12,7 @@ filemanager provides a file managing interface within a specified directory and
+ [Features](#features) + [Features](#features)
- [Users](#users) - [Users](#users)
- [Search](#search) - [Search](#search)
+ [Contributing](#contributing)
# Getting started # 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 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`.