From 9406a8651e4418f7bd29f73c7c6451a451462994 Mon Sep 17 00:00:00 2001 From: Yorick Peterse Date: Thu, 11 Sep 2014 00:11:06 +0200 Subject: [PATCH] Documentation chapter in the README. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 9f30085..2eb66ec 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,14 @@ gcc or clang. Oga's C extension can be compiled with both. JRuby does not require a compiler as the native extension is compiled during the Gem building process and bundled inside the Gem itself. +## Documentation + +The documentation is best viewed [on the documentation website][doc-website]. + +* {file:contributing Contributing} +* {file:changelog Changelog} +* {file:migrating\_from\_nokogiri Migrating From Nokogiri} + ## Native Extension Setup The native extensions can be found in `ext/` and are divided into a C and Java @@ -148,3 +156,4 @@ in the root directory of this repository. [nokogiri]: https://github.com/sparklemotion/nokogiri [oga-wikipedia]: https://en.wikipedia.org/wiki/Japanese_saw#Other_Japanese_saws [ox]: https://github.com/ohler55/ox +[doc-website]: http://code.yorickpeterse.com/oga/latest/