Added basic README.md

1 files changed, 21 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc3d618
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# InputXSLT
+
+... is a proof-of-concept implementation of external read-only file access functions for XSLT based on Apache [xalan](https://xalan.apache.org/) and [xerces](https://xerces.apache.org/).
+
+## Why?!
+
+Contrary to popular opinion I actually like XSLT as a content transformation language and have built - amongst other things - my personal website on top of it. While I used the XSLT based [Symphony CMS](http://www.getsymphony.com/)  for that particular endeavour, the intention behind the experiment contained within this repository is to develop something like a static content management system based on XSLT.
+
+## Current features:
+
+- external `read-file` function for read-only access to text files
+- external `read-xml-file` function for read-only access to XML files
+- external `read-directory` function for read-only directory traversal
+
+## Requirements:
+
+- CMake
+- C++ compiler with C++11 support
+- Apache [Xalan](https://xalan.apache.org/) XSLT Processor
+- Apache [Xerces](https://xerces.apache.org/) XML Library
+- Boost [Filesystem](http://www.boost.org/doc/libs/1_55_0/libs/filesystem/doc/index.htm)