Added link to on-line docs to README.
authorStanislaw Klekot <dozzie@jarowit.net>
Sun, 29 Oct 2017 12:05:56 +0000 (13:05 +0100)
committerStanislaw Klekot <dozzie@jarowit.net>
Sun, 29 Oct 2017 12:05:56 +0000 (13:05 +0100)
README.md

index 330fd11..f4b8771 100644 (file)
--- a/README.md
+++ b/README.md
@@ -55,6 +55,13 @@ Requirements
 Linux kernel 2.6.36 or above and glibc 2.9 or above. These requirements are
 satisfied in Debian 7 Squeeze and CentOS 7.0.
 
+Documentation
+-------------
+
+`gen_inotify` is documented using EDoc. A local copy is generated with
+`make doc` command to `./doc/` directory. An already generated online copy is
+available at <http://dozzie.jarowit.net/api/erlang-gen_inotify/>.
+
 Contact and license
 -------------------