update readme and deploy to 0.2.4

islco · Mar 10, 2017 · 754f45b · 754f45b
1 parent e9e0961
commit 754f45b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -10,8 +10,23 @@ Uses Trix 0.9.
 Using django-trix
 -----------------
 
-django-trix includes both a form widget and a model admin mixin that enables
-the rich text editor.
+django-trix includes a form widget, a model field, and a model admin mixin that
+enables the rich text editor. You can use any of these methods, but you do not
+need to use all.
+
+Model
+~~~~~
+
+To enable the editor in the Django admin (or any form) via the model field, use
+the Trix model field *TrixField* which inherits from
+django.db.models.TextField::
+
+    from django.db import models
+    from trix.fields import TrixField
+
+    class Post(models.Model):
+        content = TrixField('Content')
+
 
 Admin
 ~~~~~

diff --git a/setup.py b/setup.py
@@ -4,7 +4,7 @@
 
 setup(
     name="django-trix",
-    version='0.2.3',
+    version='0.2.4',
     packages=["trix"],
     include_package_data=True,
     description="Trix rich text editor widget for Django",