summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorArmin Ronacher <armin.ronacher@active-4.com>2010-10-17 15:58:08 +0200
committerArmin Ronacher <armin.ronacher@active-4.com>2010-10-17 15:58:08 +0200
commitf55b1a4edf68a7b4403082ed2564fc7dd2de98b3 (patch)
treec4a4e24c9eaf84cc99e13b37262ba4d8b3cadc61 /README.rst
parentf858d6213820c2d54efba3bddf8ee43d3bb20dd1 (diff)
downloadjinja2-f55b1a4edf68a7b4403082ed2564fc7dd2de98b3.tar.gz
Added README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..fd5daf4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,38 @@
+Jinja2
+~~~~~~
+
+Jinja2 is a template engine written in pure Python. It provides a
+`Django`_ inspired non-XML syntax but supports inline expressions and
+an optional `sandboxed`_ environment.
+
+Nutshell
+--------
+
+Here a small example of a Jinja template::
+
+ {% extends 'base.html' %}
+ {% block title %}Memberlist{% endblock %}
+ {% block content %}
+ <ul>
+ {% for user in users %}
+ <li><a href="{{ user.url }}">{{ user.username }}</a></li>
+ {% endfor %}
+ </ul>
+ {% endblock %}
+
+Philosophy
+----------
+
+Application logic is for the controller but don't try to make the life
+for the template designer too hard by giving him too few functionality.
+
+For more informations visit the new `Jinja2 webpage`_ and `documentation`_.
+
+The `Jinja2 tip`_ is installable via `easy_install` with ``easy_install
+Jinja2==dev``.
+
+.. _sandboxed: http://en.wikipedia.org/wiki/Sandbox_(computer_security)
+.. _Django: http://www.djangoproject.com/
+.. _Jinja2 webpage: http://jinja.pocoo.org/
+.. _documentation: http://jinja.pocoo.org/2/documentation/
+.. _Jinja2 tip: http://dev.pocoo.org/hg/jinja2-main/archive/tip.tar.gz#egg=Jinja2-dev