Commits

Anthony Menasse committed d05742b

added basic usage instructions

Comments (0)

Files changed (1)

 
 == Basic usage ==
 
+add the appropriate middleware::
+
+MIDDLEWARE_CLASSES = (
+    'current_user.middleware.CurrentUserMiddleware',
+    'current_user.middleware.CreateUserMiddleware',
+)
+
+add current_user to your INSTALLED_APPS::
+
+INSTALLED_APPS = (
+    'current_user',
+    .
+    .
+)
+
+
+add the fields to your models::
+
+
+class ExampleModel(models.Model):
+
+    foo = models.IntegerField()
+    last_user = CurrentUserField(related_name="+")
+    created_by = CreateUserField(related_name="+")
+
+== Tests ==
+
+To run the tests run the current_user/tests/runtests.py script 
+
+ src/current_user/tests/runtests.py
+
 == Example ==
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.