updated docs

Author: Josh Owen

MANIFEST.in

@@ -4,5 +4,5 @@ include LICENSE
 include MANIFEST.in
 include README.rst
 
-graft robots
-recursive-exclude robots *.pyc *.pyo
+graft url_robots
+recursive-exclude url_robots *.pyc *.pyo

README.rst

@@ -1,5 +1,5 @@
 =========================
-django-robots
+django-url-robots
 =========================
 
 ``Django`` ``robots.txt`` generator. Based on using decorated ``django.conf.urls.url``.
@@ -8,44 +8,44 @@ It gets ``urlpatterns`` and replaces ambiguous parts by ``*``.
 Installation & Usage
 =========================
 
-The recommended way to install django-robots is with `pip <http://pypi.python.org/pypi/pip>`_
+The recommended way to install django-url-robots is with `pip <http://pypi.python.org/pypi/pip>`_
 
 1. Install from PyPI with ``easy_install`` or ``pip``::
 
-    pip install git+https://github.com/valeriansaliou/django-robots
+    pip install django-url-robots
 
-2. Add ``'robots'`` to your ``INSTALLED_APPS``::
+2. Add ``'url_robots'`` to your ``INSTALLED_APPS``::
 
     INSTALLED_APPS = (
         ...
-        'robots',
+        'url_robots',
         ...
         )
 
-3. Add robots view to your root URLconf::
+3. Add url_robots view to your root URLconf::
 
-    urlpatterns += patterns('',
-        url(r'^robots\.txt$', 'robots.views.robots_txt'),
-        )
+    urlpatterns += [
+        url(r'^robots\.txt$', robots.views.robots_txt),
+        ]
 
 4. Describe rules by boolean keyword argument ``robots_allow`` using for it ``robots.utils.url`` instead ``django.conf.urls.url``::
 
-    from robots.utils import url
+    from url_robots.utils import url
     
-    urlpatterns += patterns('',
-       url('^profile/private$', 'view', robots_allow=False),
-       )
+    urlpatterns += [
+       url('^profile/private$', views.some_view, robots_allow=False),
+       ]
  
-``django-robots`` tested with ``Django-1.3``. Encodes unicode characters by percent-encoding.
+``django-url-robots`` tested with ``Django-1.3``. Encodes unicode characters by percent-encoding.
 
 Settings
 ====================
 
 In this moment there are only one option to define template of ``robots.txt`` file::
 
-    urlpatterns += patterns('',
-        url(r'^robots\.txt$', 'robots.views.robots_txt', {'template': 'my_awesome_robots_template.txt'}),
-        )
+    urlpatterns += [
+        url(r'^robots\.txt$', url_robots.views.robots_txt, {'template': 'my_awesome_robots_template.txt'}),
+        ]
 
 Example
 ===================
@@ -57,23 +57,22 @@ robots_template.txt::
 
 urls.py::
 
-    from django.conf.urls import patterns, include
+    from django.conf.urls import include
 
-    urlpatterns = patterns('',
+    urlpatterns = [
         url(r'^profile', include('robots.tests.urls_profile')),
-    )
+    ]
 
 urls_profile.py::
 
-    from django.conf.urls import patterns
-    from robots.utils import url
+    from url_robots.utils import url
 
-    urlpatterns = patterns('',
-        url(r'^s$', 'view', name='profiles', robots_allow=True),
-        url(r'^/(?P<nick>\w+)$', 'view'),
-        url(r'^/(?P<nick>\w+)/private', 'view', name='profile_private', robots_allow=False),
-        url(r'^/(?P<nick>\w+)/public', 'view', name='profile_public', robots_allow=True),
-        )
+    urlpatterns = [
+        url(r'^s$', views.some_view, name='profiles', robots_allow=True),
+        url(r'^/(?P<nick>\w+)$', views.some_view),
+        url(r'^/(?P<nick>\w+)/private', views.some_view, name='profile_private', robots_allow=False),
+        url(r'^/(?P<nick>\w+)/public', views.some_view, name='profile_public', robots_allow=True),
+        ]
 
 Resulting robots.txt::