Permalink
Browse files

Include migration instructions in the readme

  • Loading branch information...
1 parent 8e56b0c commit 5f0121c1853ea013380e2c8040dae4d02e2d6a71 @mjumbewu committed Sep 6, 2012
Showing with 26 additions and 3 deletions.
  1. +14 −2 README.rst
  2. +12 −1 docs/index.rst
View
@@ -1,8 +1,20 @@
+=========================================================
NOTE: django-mustachejs is now named "django-jstemplate"!
=========================================================
-The source is available at http://github.com/mjumbewu/django-jstemplate. Please
-update your references. Thanks for using the project!
+The source is available at http://github.com/mjumbewu/django-jstemplate, and the
+package is at http://pypi.python.org/pypi/django-jstemplate/. Please
+update your references.
+
+Migration is easy:
+
+- In your settings' ``INSTALLED_APPS``, ``mustachejs`` becomes ``jstemplate``
+- ``MUSTACHEJS_...`` settings become ``JSTEMPLATE_...``
+- In your Django templates, ``{% load mustachejs %}`` becomes
+ ``{% load jstemplate %}``
+
+That's it. If you have any issues, get in touch with me on GitHub or on Twitter
+`@mjumbewu <http://www.twitter.com/mjumbewu>`_. Thanks for using the project!
=================
django-mustachejs
View
@@ -3,11 +3,22 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
+=========================================================
NOTE: django-mustachejs is now named "django-jstemplate"!
=========================================================
The docs are available at http://django-jstemplate.readthedocs.org/. Please
-update your references. Thanks for using the project!
+update your references.
+
+Migration is easy:
+
+- In your settings' ``INSTALLED_APPS``, ``mustachejs`` becomes ``jstemplate``
+- ``MUSTACHEJS_...`` settings become ``JSTEMPLATE_...``
+- In your Django templates, ``{% load mustachejs %}`` becomes
+ ``{% load jstemplate %}``
+
+That's it. If you have any issues, get in touch with me on GitHub or on Twitter
+`@mjumbewu <http://www.twitter.com/mjumbewu>`_. Thanks for using the project!
=================
django-mustachejs

0 comments on commit 5f0121c

Please sign in to comment.