From: Ralf Jung Date: Thu, 13 Nov 2014 20:07:10 +0000 (+0100) Subject: add first version of a README X-Git-Url: https://git.ralfj.de/zonemaker.git/commitdiff_plain/a0960cef88ab6c6fff5b9877f3dd647e563ba378 add first version of a README --- diff --git a/README.rst b/README.rst new file mode 100644 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 `_.