Merge branch 'master' of https://github.com/Hrish2006/MongoMan

README.md

@@ -3,9 +3,38 @@ MongoMan (MongoManager)
 
 A GUI for MongoDb
 
-MongoMan provides a graphical front end to your mongoDB installation. You can view, create, remove and inspect databases,
-documents and their contents through your web browser. I was inspired by how useful genghisapp is when I am developing
-using mongodb. However, I realized genghis' limitations because I still had to use the command line to do more powerful
-tasks like executing queries and things. MongoMan aims to include a full-blown mongodb console right in the browser. It 
-aims to make viewing, editing, saving, querying and almost every administrative function accessible via your browser.
-Fork me and contribute so we can make this better.
+MongoMan provides a graphical front end to your mongoDB installation. You can view, create, remove and inspect databases, documents and their contents through your web browser. I was inspired by how useful genghisapp is when I am developing using mongodb. However, I realized genghis' limitations because I still had to use the command line to do more powerful tasks like executing queries. MongoMan aims to include a full-blown mongodb console right in the browser. It aims to make viewing, editing, saving, querying and almost every administrative function accessible via your browser. Fork me and contribute so we can make this better.
+
+Configuration:
+=============
+
+1. clone the repository by running : git clone https://github.com/Hrish2006/MongoMan/.
+2. cd to the directory MongoMan/MongoMan.
+3. bundle install
+4. rails s -p 8000 #Start the application on its own port.
+
+navigate to http://localhost:8000 to start using the application.
+
+Features currently included in the pre-release include the standard CRUD actions.
+
+Bugs
+==========
+Raise an issue on github for any of the bugs you find while using the application. Please include the following in
+your bug description:
+
+1. Operating system
+2. Ruby Version
+3. Browser used
+4. A screenshot of the bug (if convenient)
+
+Contributing
+============
+Please submit pull requests against master and I will merge them after a code review. For feature requests
+and enhancements, please raise github issues and mark them using the appropriate labels.
+
+
+License
+========
+MongoMan is licensed under the <a href="http://www.opensource.org/licenses/MIT">MIT License</a>.
+
+