summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-02-25 11:15:59 +0100
committerSamy Pessé <samypesse@gmail.com>2016-02-25 11:15:59 +0100
commita2e0bc267c3ca0b28669344f9b07d57b55294ec5 (patch)
treeca87654809128c73931a4f996d4dc5920299ce44 /docs/README.md
parentd86a95b5e1fec23b4c48df5c693d6686df3fe74e (diff)
downloadgitbook-a2e0bc267c3ca0b28669344f9b07d57b55294ec5.zip
gitbook-a2e0bc267c3ca0b28669344f9b07d57b55294ec5.tar.gz
gitbook-a2e0bc267c3ca0b28669344f9b07d57b55294ec5.tar.bz2
Improve documentation
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index 8329a5c..6febb43 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,22 @@
-# GitBook Documentation: v{{ book.version }}
+# GitBook Format Documentation
+
+> This documentation is for GitBook version **{{ book.version }}**
+
+GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: [Learn Javascript](https://www.gitbook.com/book/GitBookIO/javascript). This documentation has been generated using GitBook.
+
+GitBook can output your content as a website ([customizable](themes.md) and [extensibles](plugins.md)) or as an ebook (PDF, ePub or Mobi).
+
+[GitBook.com](https://www.gitbook.com) is the online platform to create and host books built using the GitBook format. It offers hosting, collaboration features and an [easy-to-use editor](https://www.gitbook.com/editor).
+
+### Help and Support
+
+We're always happy to help out with your books or any other questions you might have. You can ask a question on the following contact form at [gitbook.com/contact](https://www.gitbook.com/contact) or signal an issue on [GitHub](https://github.com/GitbookIO/gitbook).
### FAQ
There are questions that are asked quite often, [check this out before creating an issue](faq.md).
+### Contribute to this documentation
+
+You can contribute to improve this documentation on [GitHub](https://github.com/GitbookIO/gitbook) by signaling issues or proposing changes.
+