add first version of a README

[zonemaker.git] / README.rst

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..733f3ba
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,34 @@
+zonemaker: Write your DNS zone files in Python
+==============================================
+
+Introduction
+------------
+
+This is zonemaker_, a tool to generate DNS zone files from Python.
+
+The plain zone file format is pretty limited. There are not even variables, so in many cases IP addresses and other data has to be repeated several times.
+zonemaker is an attempt to provide more flexibility, by allowing you to write your zones in Python.
+Hence all the usuel fatures, like variables, macros (aka functions) and loops, are available to generate DNS zone data.
+At the same time, zonemaker is reasonably simple and close to the actual structure of a DNS zonefile, so it is suited for small setups.
+The output of zonemaker is a standard zonefile, so it can be used with any DNS server supporting those.
+
+.. _dyn-nsupdate: https://www.ralfj.de/projects/zonemaker
+
+Usage
+-----
+
+TODO
+
+Source, License
+---------------
+
+You can find the sources in the `git repository`_. They are provided under a 
+2-clause BSD license.
+
+.. _git repository: http://www.ralfj.de/git/zonemaker.git
+
+Contact
+-------
+
+If you found a bug, or want to leave a comment, please
+`send me a mail <mailto:post-AT-ralfj-DOT-de>`_.