Commits

fcoelho  committed 5d36f25

readme shortened and points to documentation

  • Participants
  • Parent commits 1863140

Comments (0)

Files changed (1)

 .. _django-registration: http://bitbucket.org/ubernostrum/django-registration
 .. _James Bennett: http://www.b-list.org/
 
-Quick start
------------
+Documentation
+-------------
 
-To use the app, first add it to your ``INSTALLED_APPS``:
+Documentation can be found at http://pythonhosted.org/django-signup/
 
-.. code:: python
+Contact
+-------
 
-    INSTALLED_APPS = (
-        ...
-        'signup',
-        ...
-    )
-
-Add the ``django-signup`` URLs to your ``urlpatterns``:
-
-.. code:: python
-    
-    urlpatterns = patterns('',
-        ...
-        url(r'^accounts/', include('signup.urls')),
-        ...
-    )
-
-
-
-Next you have to set up your templates. These are the necessary templates:
-
-
-**registration/signup_form.html**
-
-* Holds the registration form. It inherits from FormView_.
-* *context*:
-    + ``form``: an instance of the configured ``SIGNUP_FORM_CLASS`` or
-      an instance of ``django.contrib.auth.forms.UserCreationForm``
-
-**registration/signup_complete.html**
-
-* A simple page indicating that the account has been created and an email has
-  been sent to finish the sign up process
-* *context*:  none
-
-**registration/activation_failed.html**
-
-* Should display a message indicating that the activation failed
-* *context*:
-    + ``activation_key``: The key used to activate the account. It's part of
-      the URL
-
-**registration/activation_complete.html**
-
-* Should display a message saying that the account was successfully activated
-* *context*: none
-
-**registration/activation_email.txt**
-
-* Contains the email subject and body, in text and optional html format. This
-  template has a special "syntax" in order to include the subject and body in
-  the same file. A sample file is shown below. Empty lines at the begin and
-  end of each block are stripped away.
-  ::
-
-    -- title=subject
-    This is the subject of the email,
-    multiple lines will be joined
-    -- title=txt
-    This is the text part of the email
-    -- title=html
-    This is the html part of the email, it's optional
-
-* *context*:
-    + ``url``: The full url to be used to activate the account. Includes the
-      domain and path
-    + ``activation_days``: How many days the user has to activate his account
-
-.. _FormView: http://ccbv.co.uk/projects/Django/1.5/django.views.generic.edit/FormView/
-
-Extra templates
----------------
-
-User registration is just a small part of the process each user will have to
-go through. In order to be useful, you still have to add things like user
-login, logout, password recovery, etc. Django already has those features built
-in, so ``django-signup`` will offload these tasks to the default
-implementation.
-
-The ``django-signup`` urls include ``django.contrib.auth.urls``. Check the
-`documentation <https://docs.djangoproject.com/en/1.5/topics/auth/default/#module-django.contrib.auth.views>`_
-to see which ones you want to implement. At the very least, you want to create
-``registration/login.html`` and ``registration/logged_out.html``.
-
-.. note::
-    Even though these are the very minimum needed for a working website, the
-    default auth URLs have many other entries which, unless you somehow remove
-    from the URL conf, will be loaded by Django when the end user tries to
-    access these URLs.
-
-    When there URLs are accessed, they will trigger a ``TemplateDoesNotExist``
-    exception which will cause (by default) a server error. Be careful.
-
-Custom user model
------------------
-
-This app was made to be most useful when using custom user models, allowing
-you to set up user registration with minimal configuration on the
-``django-signup`` side.
-
-For more information, check the documentation at <I'm currently under
-construction!>.
+Felipe Bessa Coelho (`@fbcoelho <http://twitter.com/fbcoelho>`)