Note that only supports GMT

[rbdr/ngx_http_office_hours_filter_module] / README.md

diff --git a/README.md b/README.md
index 01ab92772d1441423889182478797525eb84d32a..50211c1cb6de170df01768861656262c38f4ee6f 100644 (file)
--- 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
 
 
 ## 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*
 
 spaces. The first range will be used as the default, and the rest will
 be read from right to left, ending with *sunday*
 


@@ -61,6 +61,21 @@ 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.
 
 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
 ## Installing git hooks
 
 This repo contains a pre-commit git hook so indent will run before every


@@ -68,7 +83,12 @@ commit. Run `make setup_hooks` to install it.
 
 ## Further Improvements
 
 
 ## 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
 * 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/