django-axes/README.rst
Aleksi Häkli a5c2a2b10d
Improve README and add badges
Signed-off-by: Aleksi Häkli <aleksi.hakli@iki.fi>
2019-01-14 16:43:42 +02:00

63 lines
1.8 KiB
ReStructuredText

Django Axes
===========
.. image:: https://jazzband.co/static/img/badge.svg
:target: https://jazzband.co/
:alt: Jazzband
.. image:: https://img.shields.io/pypi/v/django-axes.svg
:target: https://pypi.org/project/django-axes/
:alt: PyPI release
.. image:: https://img.shields.io/readthedocs/django-axes.svg
:target: https://django-axes.readthedocs.io/
:alt: Documentation
.. 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
------------
Please open issues and pull requests for contributions and patches.
Separate the proposed changes into small, distinct patches by type
so that they can be merged faster into upstream and released quicker:
* Feature
* Bugfix
* Documentation
* Code style and whitespace