README.md in mongo_browser-0.1.0 vs README.md in mongo_browser-0.1.1
- old
+ new
@@ -1,27 +1,47 @@
# MongoBrowser
[![Build status](https://secure.travis-ci.org/lucassus/mongo_browser.png)](http://travis-ci.org/lucassus/mongo_browser)
+[![Dependency Status](https://gemnasium.com/lucassus/mongo_browser.png)](http://gemnasium.com/lucassus/mongo_browser)
-TODO: Write a gem description
+Simple but powerful tool for managing mongodb databases
-## Installation
+Install the gem:
-Add this line to your application's Gemfile:
+ $ gem install mongo_browser
- gem 'mongo_browser'
+## Usage
-And then execute:
+Run the application
- $ bundle
+ $ mongo_browser
-Or install it yourself as:
+Run the application as a daemon
- $ gem install mongo_browser
+ $ mongo_browser --demonize
-## Usage
+Application will be available by default at http://localhost:4567
+In order to run it on custom port number pass the `--port` option with selected port.
-TODO: Write usage instructions here
+Other options are:
+
+ $ mongo_browser --help
+ [17/11 16:10:06] Usage: mongo_browser [options]
+
+ v0.1.0
+
+ Options:
+ --version Show help/version info
+ --port PORT MongoBrowser port
+ (Default: 4567)
+ --mongodb-host HOST Mongodb database host
+ (Default: localhost)
+ --mongodb-port PORT Mongodb database port
+ (Default: 27017)
+ --demonize Run the app in the background
+ --log-level LEVEL Set the logging level
+ (debug|info|warn|error|fatal)
+ (Default: info)
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)