Ready for first alpha

Author: soerenbe

DESCRIPTION.rst

@@ -8,3 +8,30 @@ This includes:
 * Abstract UserPref Class
 * Admin interface
 * Templates for an userspecific settings page
+
+
+Basic usage
+===========
+
+Just define a abstract model that can be used in the applications.
+In you app you should define something like:
+
+.. code:: python
+
+    from userpref.models import Userpref
+
+    class MyappSettings(Userpref):
+        special_setting = models.BooleanField(default=False, verbose_name='Make me a superhero')
+        another_field = models.CharField(max_length=100, default="<unset>")
+
+        class Meta:
+            verbose_name = "My Custom Setting for app Myapp"
+
+
+In your application or template you can access the settings over the users attributes
+
+.. code:: html
+
+    {% if request.user.myappsettings.special_settings %}
+        You are special man!
+    {% endif %}

README.rst

@@ -16,11 +16,22 @@ Basic usage
 Just define a abstract model that can be used in the applications.
 In you app you should define something like:
 
+.. code:: python
+
     from userpref.models import Userpref
 
     class MyappSettings(Userpref):
         special_setting = models.BooleanField(default=False, verbose_name='Make me a superhero')
         another_field = models.CharField(max_length=100, default="<unset>")
 
         class Meta:
-            verbose_name = "My Custom Setting for app Myapp"
+            verbose_name = "My Custom Setting for app Myapp"
+
+
+In your application or template you can access the settings over the users attributes
+
+.. code:: html
+
+    {% if request.user.myappsettings.special_settings %}
+        You are special man!
+    {% endif %}

setup.py

@@ -13,7 +13,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='0.1.0a3',
+    version='0.1.0a5',
 
     description='Django user preferences',
     long_description=long_description,