Merge pull request #403 from GitbookIO/version/1.0.0

Version 1.0.0

1 files changed, 26 insertions, 69 deletions

diff --git a/README.md b/README.md
index bf300bb..b9625db 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,9 @@ GitBook
 =======
 
 [![Build Status](https://travis-ci.org/GitbookIO/gitbook.png?branch=master)](https://travis-ci.org/GitbookIO/gitbook)
+[![NPM version](https://badge.fury.io/js/gitbook.svg)](http://badge.fury.io/js/gitbook)
 
-GitBook is a command line tool (and Node.js library) for building beautiful books and exercises using GitHub/Git and Markdown. Here is an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). You can publish book easily online using [gitbook.io](https://www.gitbook.io) and an [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
+GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown. Here is an example: [Learn Javascript](https://www.gitbook.io/book/GitBookIO/javascript). You can publish book easily online using [gitbook.io](https://www.gitbook.io) and an [editor](https://github.com/GitbookIO/editor) is available for Windows, Mac and Linux. You can follow [@GitBookIO](https://twitter.com/GitBookIO) on Twitter. Complete documentation is available at [help.gitbook.io](http://help.gitbook.io/).
 
 ![Image](https://raw.github.com/GitbookIO/gitbook/master/preview.png)
 
@@ -77,23 +78,10 @@ Here are the options that can be stored in this file:
         }
     },
 
-    // Set another theme with your own layout
-    // It's recommended to use plugins or add more options for default theme, though
-    // See https://github.com/GitbookIO/gitbook/issues/209
-    "theme": "./localtheme",
-
     // Links in template (null: default, false: remove, string: new value)
     "links": {
-        // Link to home in the top-left corner
-        "home": null,
-
-        // Links in top of sidebar
-        "about": null,
-        "issues": null,
-        "contribute": null,
-
     	// Custom links at top of sidebar
-    	"custom": {
+    	"sidebar": {
     	    "Custom link name": "https://customlink.com"
     	},
 
@@ -101,7 +89,9 @@ Here are the options that can be stored in this file:
         "sharing": {
             "google": null,
             "facebook": null,
-            "twitter": null
+            "twitter": null,
+            "weibo": null,
+            "all": null
         }
     },
 
@@ -172,45 +162,6 @@ This is the summary of my book.
 
 Files that are not included in `SUMMARY.md` will not be processed by `gitbook`.
 
-#### Exercises
-
-A book can contain interactive exercises (currently only in Javascript but Python and Ruby are coming soon ;) ). An exercise is a code challenge provided to the reader, who is given a code editor to write a solution which is checked against the book author's validation code.
-
-An exercise is defined by 4 simple parts:
-
-* Exercise **Message**/Goals (in markdown/text)
-* **Initial** code to show to the user, providing a starting point
-* **Solution** code, being a correct solution to the exercise
-* **Validation** code that tests the correctness of the user's input
-
-Exercises need to start and finish with a separation bar (```---``` or ```***```). It should contain 3 code elements (**base**, **solution** and **validation**). It can contain a 4th element that provides **context** code (functions, imports of libraries, etc which shouldn't be displayed to the user).
-
-    ---
-
-    Define a variable `x` equal to 10.
-
-    ```js
-    var x =
-    ```
-
-    ```js
-    var x = 10;
-    ```
-
-    ```js
-    assert(x == 10);
-    ```
-
-    ```js
-    // This is context code available everywhere
-    // The user will be able to call magicFunc in his code
-    function magicFunc() {
-        return 3;
-    }
-    ```
-
-    ---
-
 #### Multi-Languages
 
 GitBook supports building books written in multiple languages. Each language should be a sub-directory following the normal GitBook format, and a file named `LANGS.md` should be present at the root of the repository with the following format:
@@ -242,24 +193,30 @@ The platform [GitBook.io](https://www.gitbook.io/) is like an "Heroku for books"
 
 Plugins can used to extend your book's functionality. Read [GitbookIO/plugin](https://github.com/GitbookIO/plugin) for more information about how to build a plugin for GitBook.
 
-##### Default plugins:
+##### Official plugins:
 
-* [mathjax](https://github.com/GitbookIO/plugin-mathjax): displays mathematical notation in the book.
-* [mixpanel](https://github.com/GitbookIO/plugin-mixpanel): Mixpanel tracking for your book
+| Name | Description |
+| ----- | ---- |
+| [exercises](https://github.com/GitbookIO/plugin-exercises) | Add interactive exercises to your book. |
+| [quizzes](https://github.com/GitbookIO/plugin-quizzes) | Add interactive quizzes to your book. |
+| [mathjax](https://github.com/GitbookIO/plugin-mathjax) | Displays mathematical notation in the book. |
+| [mixpanel](https://github.com/GitbookIO/plugin-mixpanel) | Mixpanel tracking for your book |
 
 ##### Other plugins:
 
-* [Google Analytics](https://github.com/GitbookIO/plugin-ga): Google Analytics tracking for your book
-* [Disqus](https://github.com/GitbookIO/plugin-disqus): Disqus comments integration in your book
-* [Autocover](https://github.com/GitbookIO/plugin-autocover): Generate a cover for your book
-* [Transform annoted quotes to notes](https://github.com/erixtekila/gitbook-plugin-richquotes): Allow extra markdown markup to render blockquotes as nice notes
-* [Send code to console](https://github.com/erixtekila/gitbook-plugin-toconsole): Evaluate javascript block in the browser inspector's console
-* [Revealable sections](https://github.com/mrpotes/gitbook-plugin-reveal): Reveal sections of the page using buttons made from the first title in each section
-* [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd): Process markdown within HTML blocks - allows custom layout options for individual pages
-* [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs): Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook
-* [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik): Piwik Open Analytics tracking for your book
-* [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors): Add linkable Github-style anchors to headings
-* [JSBin](https://github.com/jcouyang/gitbook-plugin-jsbin): Ebedded jsbin frame into your book
+| Name | Description |
+| ----- | ---- |
+| [Google Analytics](https://github.com/GitbookIO/plugin-ga) | Google Analytics tracking for your book |
+| [Disqus](https://github.com/GitbookIO/plugin-disqus) | Disqus comments integration in your book |
+| [Autocover](https://github.com/GitbookIO/plugin-autocover) | Generate a cover for your book |
+| [Transform annoted quotes to notes](https://github.com/erixtekila/gitbook-plugin-richquotes) | Allow extra markdown markup to render blockquotes as nice notes |
+| [Send code to console](https://github.com/erixtekila/gitbook-plugin-toconsole) | Evaluate javascript block in the browser inspector's console |
+| [Revealable sections](https://github.com/mrpotes/gitbook-plugin-reveal) | Reveal sections of the page using buttons made from the first title in each section |
+| [Markdown within HTML](https://github.com/mrpotes/gitbook-plugin-nestedmd) | Process markdown within HTML blocks - allows custom layout options for individual pages |
+| [Bootstrap JavaScript plugins](https://github.com/mrpotes/gitbook-plugin-bootstrapjs) | Use the [Bootstrap JavaScript plugins](http://getbootstrap.com/javascript) in your online GitBook |
+| [Piwik Open Analytics](https://github.com/emmanuel-keller/gitbook-plugin-piwik) | Piwik Open Analytics tracking for your book |
+| [Heading Anchors](https://github.com/rlmv/gitbook-plugin-anchors) | Add linkable Github-style anchors to headings |
+| [JSBin](https://github.com/jcouyang/gitbook-plugin-jsbin) | Embedded jsbin frame into your book |
 
 #### Debugging