Skip to content

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aaaaaaaalex committed Apr 20, 2021
1 parent 7fcc39e commit f507a31
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# (G)o (h)ome(p)age
GHP is a FastCGI auto-indexer similar to the NGINX Auto-index
feature, but allows for fully customisable index pages via Go Templates

## Installation
This is a very dumb single-file program. Install it wherever you like :D
For use with Nginx, see the [sample nginx config](sample.nginx.conf)

## Usage
Just run `ghp`!

`ghp -h` for full list of config options


### Writing index files
Index files are written and rendered as [Go Templates](https://golang.org/pkg/text/template/).
The currently-served directory's contents are passed as data to the index with the type `[]os.FileInfo`, and can be referenced with `.`.
For more detail, see [an example](samples/index.gohtml)

### Additional util functions

- `Request`: Get the current request (*http.Request)

- `BaseURL( *http.Request )`: returns the current request's `URL.Path`, formatted for use with the HTML `<base>` tag

0 comments on commit f507a31

Please sign in to comment.