Update readme & quick cleanup

This commit is contained in:
2020-03-02 09:00:33 -05:00
parent a41acf4983
commit 52ca6cea21
6 changed files with 50 additions and 29 deletions

View File

@@ -1,4 +1,26 @@
## ngx_http_js_challenge_module
![GitHub](https://img.shields.io/github/license/simon987/ngx_http_js_challenge_module.svg)
[![CodeFactor](https://www.codefactor.io/repository/github/simon987/ngx_http_js_challenge_module/badge)](https://www.codefactor.io/repository/github/simon987/ngx_http_js_challenge_module)
[![Development snapshots](https://ci.simon987.net/app/rest/builds/buildType(JsChallenge_Build)/statusIcon)](https://files.simon987.net/artifacts/JsChallenge/Build/)
Simple javascript proof-of-work based access for Nginx with virtually no overhead.
Easy installation: just add `load_module /path/to/ngx_http_js_challenge_module.so;` to your
`nginx.conf` file and follow the [configuration instructions](#configuration).
![throughput.png](throughput.png)
### Configuration
//todo
### Build from source
//todo
```bash