X-Git-Url: https://git.ralfj.de/zonemaker.git/blobdiff_plain/a0960cef88ab6c6fff5b9877f3dd647e563ba378..684fde7097441fab5cdb52265cfc8a43675af476:/README.rst

diff --git a/README.rst b/README.rst
index 733f3ba..86fc359 100644
--- a/README.rst
+++ b/README.rst
@@ -1,23 +1,29 @@
-zonemaker: Write your DNS zone files in Python
-==============================================
+zonemaker: Python DNS zone files
+================================
 
 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.
+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 (also 
+known as 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, it can be used with any DNS server supporting those.
 
-.. _dyn-nsupdate: https://www.ralfj.de/projects/zonemaker
+.. _zonemaker: https://www.ralfj.de/projects/zonemaker
 
 Usage
 -----
 
-TODO
+Simply call ``zonemaker`` with the zone python file as argument. The result will 
+be printed to stdout. See ``db.example.com.py`` for a sample file demonstrating 
+the use of the interface. ``Makefile.sample`` shows how a makefile which first 
+updates the zone, and then tells BIND to reload, could look like.
 
 Source, License
 ---------------