pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Readme - points to readthedocs

Browse Source
This commit is contained in:
Ross Lawley 2012-03-05 13:14:36 +00:00
parent 7564bbdee8
commit 9451c9f331
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.rst
View File

@ -3,20 +3,21 @@ MongoEngine
=========== ===========
:Info: MongoEngine is an ORM-like layer on top of PyMongo. :Info: MongoEngine is an ORM-like layer on top of PyMongo.
:Author: Harry Marr (http://github.com/hmarr) :Author: Harry Marr (http://github.com/hmarr)
:Maintainer: Ross Lawley (http://github.com/rozza)
About About
===== =====
MongoEngine is a Python Object-Document Mapper for working with MongoDB. MongoEngine is a Python Object-Document Mapper for working with MongoDB.
Documentation available at http://hmarr.com/mongoengine/ - there is currently Documentation available at http://mongoengine-odm.rtfd.org - there is currently
a `tutorial <http://hmarr.com/mongoengine/tutorial.html>`_, a `user guide a `tutorial <http://readthedocs.org/docs/mongoengine-odm/en/latest/tutorial.html>`_, a `user guide
<http://hmarr.com/mongoengine/userguide.html>`_ and an `API reference <http://readthedocs.org/docs/mongoengine-odm/en/latest/userguide.html>`_ and an `API reference
<http://hmarr.com/mongoengine/apireference.html>`_. <http://readthedocs.org/docs/mongoengine-odm/en/latest/apireference.html>`_.
Installation Installation
============ ============
If you have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ If you have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
you can use ``easy_install -U mongoengine``. Otherwise, you can download the you can use ``easy_install -U mongoengine``. Otherwise, you can download the
source from `GitHub <http://github.com/hmarr/mongoengine>`_ and run ``python source from `GitHub <http://github.com/MongoEngine/mongoengine>`_ and run ``python
setup.py install``. setup.py install``.
Dependencies Dependencies
@ -84,14 +85,14 @@ the standard port, and run ``python setup.py test``.
Community Community
========= =========
- `MongoEngine Users mailing list - `MongoEngine Users mailing list
<http://groups.google.com/group/mongoengine-users>`_ <http://groups.google.com/group/mongoengine-users>`_
- `MongoEngine Developers mailing list - `MongoEngine Developers mailing list
<http://groups.google.com/group/mongoengine-dev>`_ <http://groups.google.com/group/mongoengine-dev>`_
- `#mongoengine IRC channel <irc://irc.freenode.net/mongoengine>`_ - `#mongoengine IRC channel <irc://irc.freenode.net/mongoengine>`_
Contributing Contributing
============ ============
The source is available on `GitHub <http://github.com/hmarr/mongoengine>`_ - to The source is available on `GitHub <http://github.com/MongoEngine/mongoengine>`_ - to
contribute to the project, fork it on GitHub and send a pull request, all contribute to the project, fork it on GitHub and send a pull request, all
contributions and suggestions are welcome! contributions and suggestions are welcome!