Credits and readme

2 files changed, 35 insertions, 0 deletions

diff --git a/CREDITS b/CREDITS
new file mode 100644
index 0000000..b4de683
--- /dev/null
+++ b/CREDITS
@@ -0,0 +1,9 @@
+Clod Credits
+------------
+
+Clod is primarily written by Daniel Silverstone with input from Rob Kendrick
+and Lars Wirzenius.
+
+Clod was sponsored, in part, by Codethink Limited by dint of extended
+lunchbreaks, the supply of tea and biscuits and also permission to use slack
+time for development.
diff --git a/README b/README
new file mode 100644
index 0000000..e4eaf5f
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+Configuration Language Organised (by) Dots
+==========================================
+
+Clod is a simple dotted configuration language where configuration files
+contain key/value pairs.  Each key is entered into a dotted heirarchy such that
+the application using Clod can query groups of elements, iterate pairs, etc.
+
+An example Clod configuration file might be:
+
+    -------8<--------
+    project.name "Clod"
+    project.description "Configuration language Organised (by) Dots"
+    project.head "refs/heads/master"
+    
+    cia.project "lua-clod"
+    
+    commit.maillist "clod-commits@gitano.org.uk"
+    commit.devlist "clod-dev@gitano.org.uk"
+    -------8<--------
+
+Note that blank lines are permitted, but otherwise there is no supported
+comment syntax.  Since Clod files are interpreted as Lua files by the current
+Clod implementation, you *can* make comments of the form `-- this is a comment`
+however this is not guaranteed and cannot be maintained by the library if you
+use Clod's ability to rewrite configuration files.
+