summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Chabowski <kevin@kch42.de>2013-10-25 22:34:01 +0200
committerKevin Chabowski <kevin@kch42.de>2013-10-25 22:34:01 +0200
commitc35b88902882ada77fe97d0755974e21a1d4e891 (patch)
treeb0c24b41dddac2c8ba104f09a463259a6f6b21d6
parentf18ecd10c746641a9f46392f24d8d87ed60d2de6 (diff)
downloadste-c35b88902882ada77fe97d0755974e21a1d4e891.tar.gz
ste-c35b88902882ada77fe97d0755974e21a1d4e891.tar.bz2
ste-c35b88902882ada77fe97d0755974e21a1d4e891.zip
Improved readme
-rw-r--r--README.markdown14
1 files changed, 6 insertions, 8 deletions
diff --git a/README.markdown b/README.markdown
index 37c10ae..e3a1321 100644
--- a/README.markdown
+++ b/README.markdown
@@ -21,13 +21,11 @@ Why should you use it?
* It can transcompile templates into PHP.
* You can use anonymous functions to define custom tags.
-Annoying things.
-----------------
+Documentation
+-------------
-* No caching. Could be slow on websites with many hits.
-
-WARNING
--------
-
-Early development, that means that it might be pretty buggy at the moment...
+The `docu` directory contains the documentation of the template language.
+If you need the documentation of the php code / the API, you can create it with the `mkdocu.sh` script.
+You will need [NaturalDocs](http://www.naturaldocs.org/) for that.
+There is also a mirror of the documentation [here](http://r7r.kch42.net/ste_docu/).