JazzBand project guidelines

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+[![Jazzband](https://jazzband.co/static/img/jazzband.svg)](https://jazzband.co/)
+
+This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines).

README.md

@@ -1,29 +1,22 @@
-## Django-invitations - Generic invitations app
+# Django-invitations - Generic invitations app
 
+[![Jazzband](https://jazzband.co/static/img/badge.svg)](https://jazzband.co/)
+[![PyPI Download](https://img.shields.io/pypi/v/django-invitations.svg)](https://pypi.python.org/pypi/django-invitations)
+[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/django-invitations.svg)](https://pypi.python.org/pypi/django-invitations)
 [![Build Status](https://travis-ci.org/bee-keeper/django-invitations.svg?branch=master)](https://travis-ci.org/bee-keeper/django-invitations)
-
 [![Coverage Status](https://coveralls.io/repos/bee-keeper/django-invitations/badge.svg?branch=master&service=github)](https://coveralls.io/github/bee-keeper/django-invitations?branch=master)
 
-### About
+## About
+
 Generic invitations solution with adaptable backend and support for django-allauth.  All emails and messages are fully customisable.
 
 Originally written as an invitations solution for the excellent [django-allauth](https://github.com/pennersr/django-allauth), this app has been refactored to remove the allauth dependency whilst retaining 100% backwards compatibility.
 
-Generic Invitation flow:
-
-* Priviledged user invites prospective user by email (via either Django admin, form post, JSON post or programmatically)
-* User receives invitation email with confirmation link
-* User clicks link and is redirected to a preconfigured url (default is accounts/signup)
+## Contributing
 
+As we are members of a [JazzBand project](https://jazzband.co/projects), `django-invitations` contributors should adhere to the [Contributor Code of Conduct](https://jazzband.co/about/conduct).
 
-Allauth Invitation flow:
-
-* As above but..
-* User clicks link, their email is confirmed and they are redirected to signup
-* The signup URL has the email prefilled and upon signing up the user is logged into the site
-
-
-### Generic Installation
+## Installation
 
 ```
 pip install django-invitations
@@ -39,6 +32,24 @@ url(r'^invitations/', include('invitations.urls', namespace='invitations')),
 python manage.py migrate
 ```
 
+## Usage
+
+There are two primary ways to use `django-invitations` described below.
+
+Generic Invitation flow:
+
+* Priviledged user invites prospective user by email (via either Django admin, form post, JSON post or programmatically)
+* User receives invitation email with confirmation link
+* User clicks link and is redirected to a preconfigured url (default is accounts/signup)
+
+Allauth Invitation flow:
+
+* As above but..
+* User clicks link, their email is confirmed and they are redirected to signup
+* The signup URL has the email prefilled and upon signing up the user is logged into the site
+
+Further details can be found in the following sections.
+
 ### Allauth Integration
 
 As above but note that invitations must come after allauth in the INSTALLED_APPS
@@ -150,6 +161,7 @@ The following signals are emitted:
 
 
 ### Management Commands
+
 Expired and accepted invites can be cleared as so:
 
 `python manage.py clear_expired_invitations`