X-Git-Url: https://git.r.bdr.sh/rbdr/ngx_http_office_hours_filter_module/blobdiff_plain/31993a1682d3be9fb3489918874815d3598f8412..bbe15175600a074663d368a9f44e27848e3ed915:/README.md?ds=sidebyside diff --git a/README.md b/README.md index c0ecead..50211c1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A victory for the server's labor rights: An nginx module that allows you to serv ## Using the directive -The `office_hours` directive expects a list of time ranges sepaarated by +The `office_hours` directive expects a list of time ranges separated by spaces. The first range will be used as the default, and the rest will be read from right to left, ending with *sunday* @@ -61,9 +61,34 @@ Uninstall nginx. I'm still not sure! I'm learning how to build this nginx module, so I'll figure it out as I go and add it here. +* [astyle][astyle]: Used to format the code +* An `nginx` [source distribution][nginx] to compile the code. + +## Building the module + +You can build this module as a dynamic module. From the `nginx` source +directory run: + +``` +./configure --add-dynamic-module=/path/to/ngx_http_office_hours_filter_module +make +``` + +For more information check the [nginx docs][nginx-module-docs] + +## Installing git hooks + +This repo contains a pre-commit git hook so indent will run before every +commit. Run `make setup_hooks` to install it. + ## Further Improvements +* Add support for timezones (currently only GMT) * Add support for public holidays * Add support to respect the time zone of the visitor and not just the server * Add support for double shifts in the same day + +[astyle]: http://astyle.sourceforge.net +[nginx]: https://nginx.org/en/download.html +[nginx-module-docs]: https://www.nginx.com/resources/wiki/extending/