Add documentation

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644 (file)
index 0000000..e0f6ead
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+- This CHANGELOG
+- A README
+- A CONTRIBUTING guide
+- indent.pro file for automatic formatting
+- Git hook to format code before commit
+- Makefile with tasks to format and install git hooks
+- A gitignore file
+
+[Unreleased]: https://gitlab.com/rbdr/ngx_office_hours/compare/master...develop

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..4a7aded
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# Contributing to ngx_office_hours
+
+This NGINX module has the simple goal of allowing you to specify office
+hours for your server, any contributions are welcome especially if it
+makes that goal easier to achieve.
+
+## The objective of Sumo
+
+Give your web server the benefit of a regulated work schedule, and
+notify the consumers of the appropriate office hours to visit the
+website.
+
+A big factor currently not considered is to serve the site in the time
+zone of the visitor, currently it is tied to server time.
+
+## How to contribute
+
+Above All: Be nice, always.
+
+* Ensure the style checker shows no warnings or errors
+* Don't break the CI
+* Make the PRs according to [Git Flow][gitflow]: (features go to
+  develop, hotfixes go to master)
+
+[gitflow]: https://github.com/nvie/gitflow

diff --git a/README.md b/README.md
index a56c1e0d0d19d0f9ed7887581f7cc7d6c2ee906d..c0eceadaad1204de7e0bd932ee2f792cee82e9d2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,69 @@
 # Nginx Office Hours
 
-A victory for the server's labor rights: An nginx module that allows you to serve your content only during office hours.
\ No newline at end of file
+A victory for the server's labor rights: An nginx module that allows you to serve your content only during office hours.
+
+## Using the directive
+
+The `office_hours` directive expects a list of time ranges sepaarated by
+spaces. The first range will be used as the default, and the rest will
+be read from right to left, ending with *sunday*
+
+### Example 1: Open 24 hours
+
+Don't use this directive.
+
+### Example 2: Open every day from 08:30 AM to 7:00 PM
+
+```
+office_hours 8:30-19;
+```
+
+Some things worth noting here: the format of time ranges uses 24 hour
+style, so no pesky AMs or PMs. Likewise, minutes are optional. Finally,
+note that since only one range was defined, this is applied to all days
+of the week. Another noteworthy 
+
+### Example 3: Open every day from 08:30 AM to 7:00 PM, but closed sundays
+
+```
+office_hours 8:30-19 closed;
+```
+
+Two important things here: first notice that the closed keyword
+specifies that the server is closed on a specific day; second, notice
+how the last element is used for sunday, while the first one still
+applies to Monday-Saturday.
+
+### Example 4: Open weekdays from 08:30 AM to 7:00 PM, Saturdays 10:00 AM to 4:00 PM, closed on sundays
+
+```
+office_hours 8:30-19 10-16 closed;
+```
+
+Now hopefully you can see the pattern: The first time range applies to
+Monday-Friday, next one to Saturday and last one to Sunday.
+
+### Example 5: Open weekdays from 08:30 AM to 7:00 PM, closed on thursdays, reduced hours on weekends.
+
+```
+office_hours 8:30-19 closed 8:30-19 10-16 10-16;
+```
+
+Since we had to specify from Thursday, we have to explicitly set the
+values for Friday, Saturday and Sunday.
+
+### Example 6: Closed every day.
+
+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.
+
+## Further Improvements
+
+* 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