From 82b7f47cf4e722ea0f994aee2f07d0163f272e98 Mon Sep 17 00:00:00 2001 From: Julio Cesar Date: Sun, 5 Jul 2015 02:25:42 -0500 Subject: [PATCH] Add text and change format of Readme file. --- README.md | 2 -- README.rst | 30 ++++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 2 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index f17d157..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# django-world-regions -Simple Django app to group countries in world's regions. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..45f8f4e --- /dev/null +++ b/README.rst @@ -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 \ No newline at end of file