Add support for office_hours_additional_information

[rbdr/ngx_http_office_hours_filter_module] / README.md

diff --git a/README.md b/README.md
index 50211c1cb6de170df01768861656262c38f4ee6f..d03baf71ecd40e110ff67325b6088b13a7f9c540 100644 (file)
--- 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 "<h1>Additional Information></h1>
+<p>Please do not email us asking to open the website 24/7. Send all complaints to friendship.quest/@ruben</p>"
+```
 
-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,12 +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/