X-Git-Url: https://git.r.bdr.sh/rbdr/ngx_http_office_hours_filter_module/blobdiff_plain/fa2b280d41f583da217a5bdccea67e87cdadffb6..refs/heads/main:/README.md?ds=sidebyside diff --git a/README.md b/README.md index a235d48..d03baf7 100644 --- a/README.md +++ b/README.md @@ -56,17 +56,26 @@ values for Friday, Saturday and Sunday. Uninstall nginx. -## What you will need to get started +## Adding more information + +This plugin also provides an `office_hours_additional_information` directive +that lets you add informative HTML to the page that shows when outside +office hours. + +``` +office_hours_additional_information "

Additional Information>

+

Please do not email us asking to open the website 24/7. Send all complaints to friendship.quest/@ruben

" +``` -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. +## What you will need to get started * [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 this module as a dynamic module. From the `nginx` source +You can build office hours as a dynamic module. From the `nginx` source directory run: ``` @@ -83,11 +92,14 @@ commit. Run `make setup_hooks` to install it. ## Further Improvements +* Add support for double shifts in the same day +* Add support for serving custom HTML when server is closed +* 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/