summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2014-04-02 00:56:02 -0700
committerSamy Pessé <samypesse@gmail.com>2014-04-02 00:56:02 -0700
commit85f4c3be581b9b4c7ea4959955c73b4dd86306b2 (patch)
treec6755e92cf4e6408ea0814b97e1b08bb3867a438
parenteb09f6102946a16251b44bc37a3d803d4e8cf168 (diff)
downloadgitbook-85f4c3be581b9b4c7ea4959955c73b4dd86306b2.zip
gitbook-85f4c3be581b9b4c7ea4959955c73b4dd86306b2.tar.gz
gitbook-85f4c3be581b9b4c7ea4959955c73b4dd86306b2.tar.bz2
Add base information on installation in readme
-rw-r--r--README.md32
1 files changed, 30 insertions, 2 deletions
diff --git a/README.md b/README.md
index b003ce0..6d37943 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,32 @@
-gitbook
+GitBook
=======
-Library and command line utility for generating GitBooks
+GiBook is a command line tool (and Node.js library) for building beautiful programming books and exercises using GitHub/Git and Markdown.
+
+## How to use it:
+
+GitBook can be installed from **NPM** using:
+
+```
+$ npm install gitbook -g
+```
+
+You can serve a repository as a book using:
+
+```
+$ gitbook serve ./repository
+```
+
+Or simply build the static website using:
+
+```
+$ gitbook build ./repository --output=./outputFolder
+```
+
+Options for commands `build` and `serve` are:
+
+```
+-t, --title <name> Name of the book to generate, defaults to repo name
+-i, --intro <intro> Description of the book to generate
+-g, --github <repo_path> ID of github repo like : username/repo
+```