Merge pull request #193 from losintikfos/master

Minor changes to README and docs.

README.rst

@@ -1,7 +1,7 @@
 =================
 Flask-MongoEngine
 =================
-:Info: MongoEngine for you flask app
+:Info: MongoEngine for Flask web applications.
 :Repository: https://github.com/MongoEngine/flask-mongoengine
 
 .. image:: https://travis-ci.org/MongoEngine/flask-mongoengine.svg?branch=master
@@ -20,6 +20,31 @@ Installation
 ============
 You can install this package using pypi: ``pip install flask-mongoengine``
 
+Tests
+=====
+To run the test suite, ensure you are running a local copy of Flask-MongoEngine
+and run: ``python setup.py nosetests``.
+
+To run the test suite on every supported versions of Python, PyPy and MongoEngine you can use ``tox``.
+Ensure tox and each supported Python, PyPy versions are installed in your environment:
+
+.. code-block:: shell
+
+    # Install tox
+    $ pip install tox
+    # Run the test suites
+    $ tox
+
+To run a single or selected test suits, use the nosetest convention. E.g.
+
+.. code-block:: shell
+
+    $ python setup.py nosetests --tests tests/example_test.py:ExampleTestClass.example_test_method
+
+Contributing
+============
+We welcome contributions! see  the `Contribution guidelines <https://github.com/MongoEngine/flask-mongoengine/blob/master/CONTRIBUTING.rst>`_
+
 License
 =======
 Flask-MongoEngine is distributed under MIT license, see LICENSE for more details.

docs/index.rst

@@ -142,7 +142,7 @@ You can use MongoEngine and WTForms like so::
         lang = db.StringField(max_length=3)
 
     class Post(db.Document):
-        title = db.StringField(max_length=120, required=True)
+        title = db.StringField(max_length=120, required=True, validators=[validators.InputRequired(message=u'Missing title.'),])
         author = db.ReferenceField(User)
         tags = db.ListField(db.StringField(max_length=30))
         content = db.EmbeddedDocumentField(Content)
@@ -211,7 +211,7 @@ list and then it will automatically track your queries::
     app.config['DEBUG_TB_PANELS'] = ['flask.ext.mongoengine.panels.MongoDebugPanel']
     db = MongoEngine(app)
     toolbar = DebugToolbarExtension(app)
-    
+
 
 
 Upgrading

flask_mongoengine/metadata.py

@@ -1,6 +1,6 @@
 import sys
 
-VERSION = (0, 7, 4)
+VERSION = (0, 7, 5)
 if sys.version_info >= (3, 0):
     unicode = str
     basestring = (str, bytes)

tests/test_metadata.py

@@ -23,7 +23,7 @@ def test_metadata(self):
         # Ensures change in version is legitimate
         msg = "Version do not match value in metadata.py `VERSION`"
 
-        self.assertEqual("0.7.4", self.metadata.__version__, msg)
+        self.assertEqual("0.7.5", self.metadata.__version__, msg)
 
 if __name__ == '__main__':
     unittest.main()