Update docs

r4fek · Oct 25, 2016 · 2ef280b · 2ef280b
1 parent 8bdb7a9
commit 2ef280b
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -17,13 +17,13 @@ All tools you need to start your journey with Apache Cassandra and Django Framew
 * accepts all `Cqlengine` and `cassandra.cluster.Cluster` connection options
 * automatic connection/disconnection handling
 * works well along with relational databases (as secondary DB)
-* storing sessions in Cassandra (NEW!)
+* storing sessions in Cassandra
+* working django forms
+* usable admin panel with Cassandra models
 
 ## Plans (TODO) ##
 
 * User model stored in Cassandra (auth module)
-* Admin panel for Cassandra models
-* Forms
 
 ## Installation ##
 
@@ -60,9 +60,9 @@ Recommended installation:
         
         import uuid
         from cassandra.cqlengine import columns
-        from cassandra.cqlengine.models import Model
+        from django_cassandra_engine.models import DjangoCassandraModel
         
-        class ExampleModel(Model):
+        class ExampleModel(DjangoCassandraModel):
             example_id    = columns.UUID(primary_key=True, default=uuid.uuid4)
             example_type  = columns.Integer(index=True)
             created_at    = columns.DateTime()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,9 @@
 # Django Cassandra Engine - CHANGELOG
 
+## Version 1.0 (25.10.2016)
+
+* Fix #66: `_meta` API support (by awesome @richardasaurus)
+
 ## Version 0.11.1 (01.09.2016)
 
 * Fix for #70 "AttributeError: operators (by @bezineb5)

diff --git a/docs/guide/getting_started.md b/docs/guide/getting_started.md
@@ -35,9 +35,9 @@
     #  myapp/models.py
     import uuid
     from cassandra.cqlengine import columns
-    from cassandra.cqlengine.models import Model
+    from django_cassandra_engine.models import DjangoCassandraModel
 
-    class ExampleModel(Model):
+    class ExampleModel(DjangoCassandraModel):
         example_id   = columns.UUID(primary_key=True, default=uuid.uuid4)
         example_type = columns.Integer(index=True)
         created_at   = columns.DateTime()

diff --git a/docs/index.md b/docs/index.md
@@ -27,11 +27,9 @@ in the way you're used to. You can focus on writing a good code.
 * works well along with relational databases
 * storing [sessions](guide/sessions.md) in Cassandra
 
-## Plans (TODO) ##
+## Plans (TODO)
 
 * User model stored in Cassandra (auth module)
-* Admin panel for Cassandra models
-* Forms
 
 ## Requirements
 

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -4,4 +4,5 @@ djangorestframework
 freezegun==0.3.6
 mock==1.0.1
 nose
+pypandoc
 tox