diff --git a/README.rst b/README.rst index 48034ac..a60c342 100644 --- a/README.rst +++ b/README.rst @@ -1,13 +1,54 @@ Django Compressor ================= -Compresses linked and inline JavaCcript or CSS into a single cached file. +Django Compressor can combine and compress linked and inline Javascript +or CSS found inside a Django template into cacheable static files. It does so +through use of a template tag called `compress`. -The main website for django-compressor is -`github.com/jezdez/django_compressor`_ where you can also file tickets. +HTML in between `{% compress js/css %}` and `{% endcompress %}` is parsed +and searched for CSS or JS. These styles and scripts are then processed and +concatenated. -You can also install the `in-development version`_ of django-compressor with +The default action for CSS is to rewrite paths to static files and fit them +with a cache busting timestamp. For Javascript it is to compress it using +`jsmin`. + +As the final result the template tag outputs a `