Skip to content

Commit

Permalink
edit readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adierebel committed Mar 11, 2017
1 parent 1b86186 commit a038029
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,39 @@
# OmMongo (Object Relational Mapping for MongoDB)
# OmMongo
[![Documentation Status](https://readthedocs.org/projects/ommongo/badge/?version=latest)](http://ommongo.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.org/bapakode/OmMongo.svg?branch=master)](https://travis-ci.org/bapakode/OmMongo)
[![Coverage Status](https://coveralls.io/repos/github/bapakode/OmMongo/badge.svg?branch=master)](https://coveralls.io/github/bapakode/OmMongo?branch=master)

This project is forked from MongoAlchemy project.
OmMongo is Object Relational Mapping for MongoDB, this project is forked from MongoAlchemy project.

--------
### Installation

Install using Python PIP

sudo pip install OmMongo

or download this repository and run setup.py

sudo python setup.py install

### Documentation

The documentation can be found here [https://ommongo.readthedocs.io/en/latest/index.html](https://ommongo.readthedocs.io/en/latest/index.html "OmMongo Documentation")

### Test

sudo pip install -r requirements.testing.txt

Test setup.py

coverage run --source=ommongo setup.py test

Nose Tests

nosetests --cover-tests --cover-erase --with-coverage --cover-package ommongo

### Release Notes

##### v.1.0

- fork from MongoAlchemy project

0 comments on commit a038029

Please sign in to comment.