Tino de Bruijn avatar Tino de Bruijn committed 268b8af

Updated the README to a proper rst document

Comments (0)

Files changed (1)

-## -------------------- USAGE -------------------- ##
-1. Copy the contents of 'templates' to a template folder in your project
+====================
+django-user-creation
+====================
 
-2. Adjust the activation_subject.txt and activation_email.txt to you wishes
+django-user-creation is an app that overrides the admin so that when you create users, you can easily email them a link to activate their account, or their credentials, if you choose to provide those for them.
 
-3. Append 'user_creation' to your INSTALLED_APPS setting
+Usage
+=====
 
-4. Add 'from user_creation import useradmin' in you root urls.py *after* 'admin.autodiscover()'
+1. Install ``django-user-creation`` into your python path.
+#. Copy the contents of ``templates`` to a template folder in your project
+#. Adjust the activation_subject.txt and activation_email.txt to your wishes
+#. Append ``'user_creation'`` to your ``INSTALLED_APPS`` setting
+#. Add ``from user_creation import useradmin`` in you root urls.py **after** 
+   ``admin.autodiscover()``
+#. Add::
 
-5. Add  
-    # user_creation
-    (r'^user_creation/', include('user_creation.urls')),
-   to your root urls.py
+	    # user_creation
+	    (r'^accounts/', include('user_creation.urls')),``
    
-6. If your templates don't extend a site called "base_site.html", adjust "activate.html" accordingly.
+   to your root urls.py. You can change the base url ('accounts/') to 
+   something different if you want. Note that it only contains a suburl 
+   'activate/', so even if you have other stuff included at 'accounts/', you 
+   should be fine.
+#. If your templates don't extend a main template called ``base_site.html``, adjust ``activate.html`` accordingly.
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.