Permalink
Browse files

Updated the readme with some better information

  • Loading branch information...
1 parent 3f7d643 commit f40b7fcbc3990e33e8b25d9940134e3ccbf75191 Corey Oordt committed Sep 15, 2010
Showing with 39 additions and 0 deletions.
  1. +39 −0 README.rst
View
@@ -0,0 +1,39 @@
+=============
+Django InLaws
+=============
+
+Were you ever looking at a record in your Django admin and wonder what else that object was related to? Django-InLaws shows you the relations of the object automatically!
+
+.. image:: http://github.com/washingtontimes/django-inlaws/raw/master/doc_src/screenshot.png
+
+**This is a proof of concept/request for comments release**
+
+Installation
+============
+
+Use pip or easy_install to install the package from PyPI::
+
+ pip install django-inlaws
+
+or::
+
+ easy_install django-inlaws
+
+Or checkout the source from `github <http://github.com/washingtontimes/django-inlaws>`_ and run::
+
+ python setup.py install
+
+Usage
+=====
+
+Usage is very simple.
+
+1. Add "inlaws" to your ``INSTALLED_APPS``\ .
+
+2. Create an "admin" directory in your project's template directory.
+
+3. Create a file called ``change_form.html``\ .
+
+4. The contents of the file should be::
+
+ {% extends "inlaws/change_form.html" %}

0 comments on commit f40b7fc

Please sign in to comment.