From 89a2116630823d2b6e6220d5950dc670a286df42 Mon Sep 17 00:00:00 2001 From: bashu Date: Wed, 5 Aug 2015 11:17:19 +0600 Subject: [PATCH] add badges --- README.rst | 47 +++++++++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index 621fdb5..eed6431 100644 --- a/README.rst +++ b/README.rst @@ -1,21 +1,31 @@ -``django-tracking`` is a simple attempt at keeping track of visitors to -Django-powered Web sites. It also offers basic blacklisting capabilities. +``django-tracking`` is a simple attempt at keeping track of visitors +to django-powered Web sites. It also offers basic blacklisting +capabilities. -The offial repository for ``django-tracking`` is at -http://bitbucket.org/codekoala/django-tracking. Please file any tickets there. +Authored by `Josh VanderLinden `_, and some great +`contributors `_. +.. image:: https://img.shields.io/pypi/v/django-tracking.svg + :target: https://pypi.python.org/pypi/django-tracking/ + +.. image:: https://img.shields.io/pypi/dm/django-tracking.svg + :target: https://pypi.python.org/pypi/django-tracking/ + +.. image:: https://img.shields.io/github/license/bashu/django-tracking.svg + :target: https://pypi.python.org/pypi/django-tracking/ + Features -======== +-------- * Tracks the following information about your visitors: - * Session key - * IP address - * User agent - * Whether or not they are a registered user and logged in - * Where they came from (http-referer) - * What page on your site they last visited - * How many pages on your site they have visited + * Session key + * IP address + * User agent + * Whether or not they are a registered user and logged in + * Where they came from (HTTP-REFERER) + * What page on your site they last visited + * How many pages on your site they have visited * Allows user-agent filtering for visitor tracking * Automatic clean-up of old visitor records @@ -24,17 +34,18 @@ Features * The ability to have a live feed of active users on your website * Template tags to: - * display how many active users there are on your site - * determine how many active users are on the same page within your site + * display how many active users there are on your site + * determine how many active users are on the same page within your site * Optional "Active Visitors Map" to see where visitors are in the world Requirements -============ +------------ -As far as I am aware, the only requirement for django-tracking to work is a -modern version of Django. I developed the project on Django 1.0 alpha 2 and -beta 1. It is designed to work with the newforms-admin functionality. +As far as I am aware, the only requirement for ``django-tracking`` to +work is a modern version of Django. I developed the project on Django +1.0 alpha 2 and beta 1. It is designed to work with the +newforms-admin functionality. If you wish to use a Google Map to display where your visitors are probably at, you must have a `Google Maps API key