short description of xml-format

1 files changed, 23 insertions, 0 deletions

diff --git a/etc/nationaldays/README b/etc/nationaldays/README
new file mode 100644
index 0000000..a65236f
--- a/dev/null
+++ b/etc/nationaldays/README
@@ -0,0 +1,23 @@
+Config files for the nationalholiday plugin
+
+Format is simple:
+Standard-xml file. 
+It must always enclosed by
+<nationaldays>
+...
+</nationaldays>
+
+then a short description tag.
+<description value="german holidays"/>
+
+for example. It should be used later on.
+
+then a list of non-floating holidays follows, encapsulated with 
+<entries>
+...
+</entries>
+
+Each entry has the form 
+<entry date="M-D" name="description of holiday"/>
+
+floating holidays are not supported this moment.