From 6f1cde127e65ee777957f9b3e38c311e75cf2a8b Mon Sep 17 00:00:00 2001 From: "gabriele.lana" Date: Tue, 25 Feb 2014 11:39:32 +0100 Subject: [PATCH] Basic Install/Disable instructions --- README.md | 40 ++++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1d65ef4..d01d735 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,30 @@ # MongoDB Shell Extensions -Simple collection of utilities to make the life inside of the MongoDB shell a little bit easier - -# How to Use -...TODO... +Collection of utilities to make the life inside of the MongoDB shell a little bit easier # How to Install -You need to have installed the latest version of [NodeJS](http://nodejs.org) -* `npm install --global bower grunt-cli` -* then inside the root directory of this project - * `npm install` - * `bower install` - * `grunt install` +Install as a global module of npm +``` +npm install --global mongodb-shell-extensions +``` +You will find a `.mongorc` file in your home directory that contains all the extensions. This file will be loaded automatically in the next MongoDB shell session + +The next time you'll start a MongoDB shell you should see a message like this (the message will not be displayed if the shell is in quiet mode `mongo --quiet`) +``` +$ mongo +MongoDB shell version: 2.4.8 +connecting to: test ++ MongoDB Shell Extensions by Gabriele Lana +> +``` -# TODO -* printcsv method -* have some methods to generate fake data/documents -* execute same query on multiple collections and merge the results (scatter & gather) +# How to Disable +If you want to temporary disable the extensions you can start the MongoDB shell with the `--norc` flag +``` +$ mongo --norc +MongoDB shell version: 2.4.8 +connecting to: test +> +``` + +# How to Use +...TODO...