standard documentation

Signed-off-by: Khash Sajadi <[email protected]>

Author: khash

README.md

@@ -1,11 +1,40 @@
-# mysql
+# MySQL
+
 MySQL backend for CoreDNS
 
-## Supported Record Types
+## Name
+MySQL - MySQL backend for CoreDNS
+
+## Description
+
+This plugin uses MySQL as a backend to store DNS records. These will then can served by CoreDNS. The backend uses a simple, single table data structure that can be shared by other systems to add and remove records from the DNS server. As there is no state stored in the plugin, the service can be scaled out by spinning multiple instances of CoreDNS backed by the same database.
+
+## Syntax
+```
+mysql {
+    dsn DSN
+    [table_prefix TABLE_PREFIX]
+    [max_lifetime MAX_LIFETIME]
+    [max_open_connections MAX_OPEN_CONNECTIONS]
+    [max_idle_connections MAX_IDLE_CONNECTIONS]
+    [ttl DEFAULT_TTL]
+    [zone_update_interval ZONE_UPDATE_INTERVAL]
+}
+```
+
+`dsn` DSN for MySQL as per https://github.com/go-sql-driver/mysql examples. You can use `$ENV_NAME` format in the DSN, and it will be replaced with the environment variable value.
+`table_prefix` Prefix for the MySQL tables. Defaults to `coredns_`.
+`max_lifetime` Duration (in Golang format) for a SQL connection. Default is 1 minute.
+`max_open_connections` Maximum number of open connections to the database server. Default is 10.
+`max_idle_connections` Maximum number of idle connections in the database connection pool. Default is 10.
+`ttl` Default TTL for records without a specified TTL in seconds. Default is 360 (seconds)
+`zone_update_interval` Maximum time interval between loading all the zones from the database. Default is 10 minutes.
+
+##3 Supported Record Types
 
 A, AAAA, CNAME, SOA, TXT, NS, MX, CAA and SRV. This backend doesn't support AXFR requests. It also doesn't support wildcard records yet.
 
-## Setup
+## Setup (as an external plugin)
 
 Add this as an external plugin in `plugin.cfg` file: 
 
@@ -22,18 +51,6 @@ $ go build
 
 Add any required modules to CoreDNS code as prompted.
 
-## Configuration
-
-In the Corefile, `mysql` can be configured with the following parameters:
-
-`dsn` DSN for MySQL as per https://github.com/go-sql-driver/mysql examples. You can use `$ENV_NAME` format in the DSN, and it will be replaced with the environment variable value.
-`table_prefix` Prefix for the MySQL tables. Defaults to `coredns_`.
-`max_lifetime` Duration (in Golang format) for a SQL connection. Default is 1 minute.
-`max_open_connections` Maximum number of open connections to the database server. Default is 10.
-`max_idle_connections` Maximum number of idle connections in the database connection pool. Default is 10.
-`ttl` Default TTL for records without a specified TTL in seconds. Default is 360 (seconds)
-`zone_update_interval` Maximum time interval between loading all the zones from the database. Default is 10 minutes.
-
 ## Database Setup
 This plugin doesn't create or migrate database schema for its use yet. To create the database and tables, use the following table structure (note the table name prefix):
 
@@ -55,16 +72,16 @@ Each record served by this plugin, should belong to the zone it is allowed to se
 ```sql
 -- Insert batch #1
 INSERT INTO coredns_records (zone, name, ttl, content, record_type) VALUES
-('test.', 'foo', 30, '{"ip": "1.1.1.1"}', 'A'),
-('test.', 'foo', '60', '{"ip": "1.1.1.0"}', 'A'),
-('test.', 'foo', 30, '{"text": "hello"}', 'TXT'),
-('test.', 'foo', 30, '{"host" : "foo.test.","priority" : 10}', 'MX');
+('example.org.', 'foo', 30, '{"ip": "1.1.1.1"}', 'A'),
+('example.org.', 'foo', '60', '{"ip": "1.1.1.0"}', 'A'),
+('example.org.', 'foo', 30, '{"text": "hello"}', 'TXT'),
+('example.org.', 'foo', 30, '{"host" : "foo.example.org.","priority" : 10}', 'MX');
 ```
 
 These can be queries using `dig` like this:
 
 ```shell script
-$ dig A MX foo.test 
+$ dig A MX foo.example.org 
 ```
 
 ### Acknowledgements and Credits