Browse files

updated readme

  • Loading branch information...
1 parent b15b20b commit 937a6192de20980e0b71d6a340fe0ee2966771c3 Chris Reeves committed Sep 24, 2011
Showing with 7 additions and 6 deletions.
  1. +7 −6 README.rst
View
13 README.rst
@@ -25,14 +25,15 @@ Installation
1. Add django_js_utils to your python path and add the django_js_utils application to your INSTALLED_APPS (if you want
to use the management command)
-2. Set the name of the file that will be generated by the management command in django_js_utils/settings.py.
-Default::
- # Where to put the Javascript URL Routing file
+2. Set the path and file name to generate urls to inside your django settings file.
+Example::
URLS_JS_GENERATED_FILE='static/js/dutils.conf.urls.js'
-The path is relative to the root of your Django project
+3. Set the url namespaces or names to resolve - only names specified in this list will be resolved to the file
+Example::
+ URLS_JS_TO_EXPOSE = ['admin', 'another_namespace', 'a_url_name',]
-3. Add dutils.js and urls routing Javascript file to every web page where you plan to use the reverse function
+4. Add dutils.js and urls routing Javascript file to every web page where you plan to use the reverse function
(likely just include in your base.html template)
Usage
@@ -56,4 +57,4 @@ TO-DO
2. Write unit tests
-3. Promote the code
+3. Promote the code

0 comments on commit 937a619

Please sign in to comment.