From d9d6c313096033036db6372beb21babe199cf78c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksi=20H=C3=A4kli?= Date: Tue, 25 Dec 2018 18:51:33 +0100 Subject: [PATCH] Improve README structure MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Aleksi Häkli --- README.rst | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 8d90844..e72c604 100644 --- a/README.rst +++ b/README.rst @@ -25,11 +25,31 @@ sort of a geeky pun, since ``axes`` can be read interpreted as: definition) your website. Hilarious, right? That's what I thought too! +Documentation +------------- + For more information see the documentation at: https://django-axes.readthedocs.io/ -If you have questions or have trouble using the app please file a bug report -at: + +Issues +------ + +If you have questions or have trouble using the app please file a bug report at: https://github.com/jazzband/django-axes/issues + + +Contributing +------------ + +Open issues and pull requests against the ``development`` branch. + +Please separate proposed changes into small, different patches by type +so that they can be merged faster into upstream and released quicker: + +* Feature +* Bugfix +* Documentation +* Code style and whitespace