Skip to content
Browse files

Updated README to reflect new setting.

Updated CHANGES to reflect new features.
Clarification in LICENSE.
  • Loading branch information...
1 parent 7033f55 commit b53b1a6c40d1ebde3f5bd58c3a47be22103f567d @jMyles jMyles committed Oct 7, 2012
Showing with 39 additions and 24 deletions.
  1. +9 −0 CHANGES.rst
  2. +1 −1 LICENSE
  3. +29 −23 README.rst
View
9 CHANGES.rst
@@ -1,6 +1,15 @@
Changes
*******
+0.5
+---
+Added COLDBREW_FAIL_LOUD setting
+Added test coverage
+Tags now work with staticfiles app
+
+
+***CHANGES BELOW ARE PRIOR TO FORK FROM django-coffeescript***
+
0.4
---
View
2 LICENSE
@@ -23,7 +23,7 @@ THE SOFTWARE.
django-coldbrew contains code from Andrey Fedoseev's Django Coffeescript
-------------------
-Copyright (c) 2011 django-coffeescript authors (see AUTHORS file)
+Copyright (c) 2011 django-coffeescript authors (see django-coffeescript AUTHORS file)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
View
52 README.rst
@@ -3,13 +3,13 @@ ColdBrew
django-coldbrew started as a fork of Django Coffeescript.
-Django CoffeeScript provides template tags to compile CoffeeScript into JavaScript from templates.
-It works with both inline code and extenal files.
+ColdBrew provides template tags to compile CoffeeScript into JavaScript from templates.
+It works with both inline code and external files.
Installation
************
-1. Add ``"coffeescript"`` to ``INSTALLED_APPS`` setting.
+1. Add ``"coldbrew"`` to ``INSTALLED_APPS`` setting.
2. Make sure that you have ``coffee`` executable installed. See
`CoffeeScript official site <http://jashkenas.github.com/coffee-script/>`_ for details.
3. Optionally, you can specify the full path to ``coffee`` executable with ``COFFEESCRIPT_EXECUTABLE`` setting.
@@ -18,12 +18,31 @@ Installation
Example Usage
*************
+External file
+-------------
+
+::
+ {% load coffeescript %}
+
+ <script type="text/javascript"
+ src="{{ STATIC_URL}}{% coffeescript "path/to/script.coffee" %}">
+ </script>
+
+renders to
+
+::
+
+ <script type="text/javascript"
+ src="/media/COFFEESCRIPT_CACHE/path/to/script-91ce1f66f583.js">
+ </script>
+
+
Inline
------
::
- {% load coffeescript %}
+ {% load coldbrew %}
<script type="text/javascript">
{% inlinecoffeescript %}
@@ -42,24 +61,6 @@ renders to
</script>
-External file
--------------
-
-::
-
- {% load coffeescript %}
-
- <script type="text/javascript"
- src="{{ STATIC_URL}}{% coffeescript "path/to/script.coffee" %}">
- </script>
-
-renders to
-
-::
-
- <script type="text/javascript"
- src="/media/COFFEESCRIPT_CACHE/path/to/script-91ce1f66f583.js">
- </script>
Note that by default compiled files are saved into ``COFFEESCRIPT_CACHE`` folder under your ``STATIC_ROOT`` (or ``MEDIA_ROOT`` if you have no ``STATIC_ROOT`` in your settings).
You can change this folder name with ``COFFEESCRIPT_OUTPUT_DIR`` setting.
@@ -81,4 +82,9 @@ Settings
Cache timeout for inline scripts (in seconds). Default: 30 days.
``COFFEESCRIPT_MTIME_DELAY``
- Cache timeout for reading the modification time of external scripts (in seconds). Default: 10 seconds.
+ Cache timeout for reading the modification time of external scripts (in seconds). Default: 10 seconds.
+
+``COLDBREW_FAIL_LOUD``
+ If True, raise ColdBrewCompileError upon encountering compiling error.
+ Otherwise, records to error log.
+ Defaults to same as DEBUG.

0 comments on commit b53b1a6

Please sign in to comment.
Something went wrong with that request. Please try again.