ascension

commit 48f2f46165affcb602b7a00118ba74efccad61b1
parent 9cbd14f862627191c8c75191506d05e891277818
Author: rexxnor <rexxnor+gnunet@brief.li>
Date:   Fri, 14 Dec 2018 09:02:27 +0100

updated README

Diffstat:
M
README.md
 | 
24
+++++++++++++-----------

1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # GNS Migrator
 
 The main goal is to develop a tool to easily migrate existing DNS Zones to the
-GNU Name System using incremental Zone Transfers. (IXFR)
+GNU Name System using (incremental) Zone Transfers. (AXFR/IXFR)
 
 ## How to install
 To install the gnsmigrator simply execute one of the following commands:
@@ -25,7 +25,7 @@ python3 setup.py develop
 ```
 
 ## How to use
-If you have installed it, simply execute gnsmigrator with one of several options..
+If you have installed it, simply execute gnsmigrator with one of several options.
 You can also just run the file gnsmigrator.py itself directly.
 
 Taken from the dosctring of the gnsmigrator.py file:
@@ -33,24 +33,26 @@ Taken from the dosctring of the gnsmigrator.py file:
 GNS Migrator
 
 Usage:
-    gnsmigrator.py -t <tld> -ns <transferns>
-    gnsmigrator.py -f <txtfile>
+    gnsmigrator.py <domain> [-d]
+    gnsmigrator.py <domain> -p <port> [-d]
+    gnsmigrator.py <domain> -ns <transferns> [-d]
+    gnsmigrator.py <domain> -ns <transferns> -p <port> [-d]
     gnsmigrator.py -h | --help
     gnsmigrator.py -v | --version
 
 Options:
-    <tld>           Top level domain to migrate
-    <txtfile>       Text File containing domains to transfer
+    <port>          Port for zone transfer
+    <domain>        Domain to migrate
     <transferns>    DNS Server that does the zone transfer
+    -d --debug      Enable debugging
     -h --help       Show this screen.
     -v --version    Show version.
 ```
 
 Example use:
 ```
-# Reads domains from Textfile, setup GNS Zones and adds records from zone transfer
-gnsmigrator -f domainlist.txt
-# Contacts the nameserver to transfer the specified top level domain
-gnsmigrator -t se. -ns zonedata.iis.se.
+# Transfers the sy TLD from ns1.tld.sy.
+gnsmigrator sy -ns ns1.tld.sy.
+# Transfers the nu TLD from zonedata.iis.se with debug options enabled
+gnsmigrator nu -ns zonedata.iis.se. -d
 ```
-