Skip to content

Commit

Permalink
README updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
jose-lpa committed Jul 28, 2016
1 parent 35547ff commit a1dff34
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,27 @@ Requirements
Installation
============

Install Django Tracking Analyzer from PyPI by using ``pip``::
1. Install Django Tracking Analyzer from PyPI by using ``pip``::

pip install django-tracking-analyzer


2. Add ``'tracking_analyzer'`` entry to Django ``INSTALLED_APPS`` setting.
3. Run the migrations to load the ``Tracker`` model in your database::

python manage.py migrate tracking_analyzer

4. Install the MaxMind® GeoIP2 Country dataset. You can do this in two ways:
4.1. By running the provided management command for this::

python manage.py install_geoip_dataset


4.2. Or manually, by following the instructions in `GeoIP2 Django documentation`_.

After following those steps, you should be ready to go.


Contribution
============

Expand Down Expand Up @@ -79,6 +95,7 @@ Django Tracking Analyzer makes use of this technologies and apps, without which
.. _Django User Agents: https://pypi.python.org/pypi/django-user_agents
.. _GeoIP2 2.3.0: https://pypi.python.org/pypi/geoip2
.. _MaxMind GeoLite2 country datasets: http://dev.maxmind.com/geoip/geoip2/geolite2/
.. _GeoIP2 Django documentation: https://docs.djangoproject.com/en/1.10/ref/contrib/gis/geoip2/
.. _PEP-8: https://www.python.org/dev/peps/pep-0008/
.. _Datamaps: https://github.com/markmarkoh/datamaps
.. _TopoJSON: https://github.com/mbostock/topojson
Expand Down

0 comments on commit a1dff34

Please sign in to comment.