Skip to content

Commit

Permalink
Add text and change format of Readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
cesarcruz committed Jul 5, 2015
1 parent f8d36af commit 82b7f47
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md

This file was deleted.

30 changes: 30 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
====================
Django World Regions
====================

Simple Django app to group countries in world's regions like *Northern America*, *Eastern Europe*, etc.

Regions data are based in http://techydiary.com/region-yaml-for-django-fixtures/ thanks Stephen for that.

`Django Countries`_ is used to handle countries.

.. note:: Currently this package don't use GeoDjango neither map data.

Installation
============
1. ``pip install django-world-regions``
2. Add ``world_regions`` to ``INSTALLED_APPS``
3. ``python manage.py migrate``
4. ``python manage.py loaddata fixtures/initial_data.json``

Usage
=====

.. code::
from world_regions.models import Region
region = Region.objects.get(countries_country='US')
print region.name
.. _Django Countries: https://github.com/SmileyChris/django-countries

0 comments on commit 82b7f47

Please sign in to comment.