Permalink
Browse files

updated README to reference new CharField subclass

  • Loading branch information...
admackin committed Jul 6, 2012
1 parent a55029c commit 73f8d99f043eb15ee3ac25a2ad90a73360049594
Showing with 4 additions and 2 deletions.
  1. +4 −2 README
View
6 README
@@ -1,11 +1,13 @@
django-jsonfield is a reusable django field that allows you to store validated JSON in your model.
-It silently takes care of serialization. To use, simple add the field to one of your models.
+It silently takes care of serialization. To use, simply add the field to one of your models.
===
from django.db import models
from jsonfield import JSONField
class MyModel(models.Model):
- json = JSONField()
+ json = JSONField()
+
+For some DB backends, if you need to use the field in indexes or uniqueness constraints, the default JSONField, (which is a subclass of TextField) may not be suitable. For those cases, JSONCharField (a subclass of CharField) is provided. You will of course need to specify max_length, and it is your responsibility to ensure that this length is sufficient to hold whatever you would like the field to contain.

0 comments on commit 73f8d99

Please sign in to comment.