django-axes/README.rst
Aleksi Häkli d9d6c31309 Improve README structure
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2018-12-25 18:55:15 +01:00

55 lines
1.5 KiB
ReStructuredText

Django Axes
===========
.. image:: https://jazzband.co/static/img/badge.svg
:target: https://jazzband.co/
:alt: Jazzband
.. image:: https://secure.travis-ci.org/jazzband/django-axes.svg?branch=master
:target: http://travis-ci.org/jazzband/django-axes
:alt: Build Status
.. image:: https://codecov.io/gh/jazzband/django-axes/branch/master/graph/badge.svg
:target: https://codecov.io/gh/jazzband/django-axes
:alt: Coverage
``django-axes`` is a very simple way for you to keep track of failed login
attempts, both for the Django admin and for the rest of your site. The name is
sort of a geeky pun, since ``axes`` can be read interpreted as:
* "access", as in monitoring access attempts
* "axes", as in tools you can use hack (generally on wood). In this case,
however, the "hacking" part of it can be taken a bit further: ``django-axes``
is intended to help you *stop* people from hacking (popular media
definition) your website. Hilarious, right? That's what I thought too!
Documentation
-------------
For more information see the documentation at:
https://django-axes.readthedocs.io/
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