Permalink
Browse files

Update the README and bumping version

  • Loading branch information...
1 parent 972d32f commit 22b7ee3b9406bcec63cabb7c5b4283192fbe1d67 @sveetch committed May 5, 2012
Showing with 50 additions and 3 deletions.
  1. +49 −2 README.rst
  2. +1 −1 sveeaccounts/__init__.py
View
@@ -1,2 +1,49 @@
-**Sveetchies-account** is a Django application to embed all the registration stuff using
-**django-registration** and **django-simple-captcha**.
+.. _autobreadcrumbs: http://pypi.python.org/pypi/autobreadcrumbs
+.. _Django: https://www.djangoproject.com/
+.. _django-crispy-forms: https://github.com/maraujop/django-crispy-forms
+.. _django-simple-captcha: https://github.com/mbi/django-simple-captcha
+.. _django-registration: http://pypi.python.org/pypi/django-registration
+
+Introduction
+============
+
+**Sveetchies-account** is a `Django`_ application to embed all the registration stuff using
+`django-registration`_ and `django-simple-captcha`_.
+
+This is not really intended to be a generic app, so use it at your own risk.
+
+Actually this is just an implementation of an inherited `django-registration`_ backend with
+`django-simple-captcha`_ usage.
+
+Links
+*****
+
+* Download his `PyPi package <http://pypi.python.org/pypi/sveeaccounts>`_;
+* Clone it on his `Github repository <https://github.com/sveetch/sveeaccounts>`_;
+* Documentation and demo to come on his
+ `DjangoSveetchies page <http://sveetchies.sveetch.net/sveeaccounts/>`_.
+
+Requires
+========
+
+* `autobreadcrumbs`_;
+* `django-registration`_ >= 0.8;
+* `django-simple-captcha`_ >= 0.3.4;
+* `django-crispy-forms`_ >= 1.1.x;
+
+Install
+=======
+
+Settings
+********
+
+In your *settings* file add the app to your installed apps :
+
+::
+
+ INSTALLED_APPS = (
+ ...
+ 'sveeaccounts',
+ ...
+ )
+
View
@@ -1,2 +1,2 @@
# -*- coding: utf-8 -*-
-__version__ = '0.1'
+__version__ = '0.2'

0 comments on commit 22b7ee3

Please sign in to comment.