diff --git a/README.md b/README.md index 37ba4d1..7d15809 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,18 @@ Scenario (2) is defended against because the server operator does not know the s ## Usage +### Installation + +#### Building From Source + `ipscrub` can be built statically with nginx or as a [dynamic module](https://www.nginx.com/blog/compiling-dynamic-modules-nginx-plus/). See the `Makefile` for examples of both ways. +#### Packages + +- [Arch Linux](https://aur.archlinux.org/packages/nginx-mod-ipscrub/) (thanks to https://github.com/deep-42-thought) + +### Configuration + In your `nginx.conf`, 1. At the top-level, load the module by adding the line `load_module ngx_ipscrub_module.so;` (NOTE: only if you built as a dynamic module).