Added to the docs, mostly the user guide
This commit is contained in:
18
README.rst
18
README.rst
@@ -1,8 +1,18 @@
|
||||
===========
|
||||
MongoEngine
|
||||
===========
|
||||
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)
|
||||
|
||||
Tutorial available at http://hmarr.com/mongoengine/
|
||||
About
|
||||
=====
|
||||
MongoEngine is a Python Object-Document Mapper for working with MongoDB.
|
||||
Documentation available at http://hmarr.com/mongoengine/ -- there is currently
|
||||
a `tutorial <http://hmarr.com/mongoengine/tutorial.html>`_, a `user guide
|
||||
<http://hmarr.com/mongoengine/userguide.html>`_ and an `API reference
|
||||
<http://hmarr.com/mongoengine/apireference.html>`_.
|
||||
|
||||
**Warning:** this software is still in development and should *not* be used
|
||||
in production.
|
||||
Dependencies
|
||||
============
|
||||
pymongo 1.1+
|
||||
sphinx (optional -- for documentation generation)
|
||||
|
||||
Reference in New Issue
Block a user