aboutsummaryrefslogtreecommitdiffstats
path: root/README.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.asciidoc')
-rw-r--r--README.asciidoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.asciidoc b/README.asciidoc
index 4ce562b..7400912 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -22,7 +22,21 @@ https://kato.im[Kato.im] and https://sameroom.io[Sameroom].
The now removed SPDY implementation was sponsored by
http://www.leofs.org[LeoFS Cloud Storage].
+== Online documentation
+
+* https://ninenines.eu/docs/en/gun/1.1/guide[User guide]
+* https://ninenines.eu/docs/en/gun/1.1/manual[Function reference]
+
+== Offline documentation
+
+* While still online, run `make docs`
+* User guide available in `doc/` in PDF and HTML formats
+* Function reference man pages available in `doc/man3/` and `doc/man7/`
+* Run `make install-docs` to install man pages on your system
+* Full documentation in Asciidoc available in `doc/src/`
+
== Getting help
* Official IRC Channel: #ninenines on irc.freenode.net
+* https://github.com/ninenines/gun/issues[Issues tracker]
* https://ninenines.eu/services/[Commercial Support]