X-Git-Url: https://git.r.bdr.sh/rbdr/ngx_http_office_hours_filter_module/blobdiff_plain/900e0f4a681f8587a12d0c446520213f4a60bb3f..6978a833d4eec780998702e235b912f2b111d2c5:/README.md diff --git a/README.md b/README.md index 01ab927..658e64f 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* @@ -58,8 +58,21 @@ Uninstall nginx. ## What you will need to get started -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. +* A way to compile `nginx`. Check out [their guide][nginx-guide]! + +## Building the module + +You can build office hours 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 @@ -68,7 +81,13 @@ 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-guide]: https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/#sources +[nginx-module-docs]: https://www.nginx.com/resources/wiki/extending/