doc: mention API documentation in README

libuv · Sep 11, 2014 · 95797f4 · 95797f4
1 parent 32e2e75
commit 95797f4
Showing 1 changed file with 29 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -38,16 +38,42 @@ used by Mozilla's [Rust language](http://www.rust-lang.org/),
 
 Starting with version 1.0.0 libuv follows the [semantic versioning](http://semver.org/)
 scheme. The API change and backwards compatiblity rules are those indicated by
-SemVer. libuv will keel a stable ABI across major releases.
+SemVer. libuv will keep a stable ABI across major releases.
 
 ## Community
 
  * [Mailing list](http://groups.google.com/group/libuv)
 
 ## Documentation
 
- * [include/uv.h](https://github.com/joyent/libuv/blob/master/include/uv.h)
-   &mdash; API documentation in the form of detailed header comments.
+### Official API documentation
+
+Located in the docs/ subdirectory. It uses the [Sphinx](http://sphinx-doc.org/)
+framework, which makes it possible to build the documentation in multiple
+formats.
+
+Show different supported building options:
+
+    $ make help
+
+Build documentation as HTML:
+
+    $ make html
+
+Build documentation as man pages:
+
+    $ make man
+
+Build documentation as ePub:
+
+    $ make epub
+
+NOTE: Windows users need to use make.bat instead of plain 'make'.
+
+Documentation can be browsed online [here](http://docs.libuv.org).
+
+### Other resources
+
  * [An Introduction to libuv](http://nikhilm.github.com/uvbook/)
    &mdash; An overview of libuv with tutorials.
  * [LXJS 2012 talk](http://www.youtube.com/watch?v=nGn60vDSxQ4)