Update docs

Author: BrandonRoehl

README.md

@@ -46,11 +46,10 @@ func main() {
   }
   fmt.Printf("File is saved to %s", resultFilename)
 
-  // Close dumper and connected database
+  // Close dumper, connected database and file stream.
   dumper.Close()
 }
-
 ```
 
-[![GoDoc](https://godoc.org/github.com/JamesStewy/go-mysqldump?status.svg)](https://godoc.org/github.com/JamesStewy/go-mysqldump)
-[![Build Status](https://travis-ci.org/JamesStewy/go-mysqldump.svg?branch=master)](https://travis-ci.org/JamesStewy/go-mysqldump)
+[![GoDoc](https://godoc.org/github.com/jamf/go-mysqldump?status.svg)](https://godoc.org/github.com/jamf/go-mysqldump)
+[![Build Status](https://travis-ci.org/jamf/go-mysqldump.svg?branch=master)](https://travis-ci.org/jamf/go-mysqldump)

doc.go

@@ -8,39 +8,47 @@ This example uses the mymysql driver (example 7 https://github.com/ziutek/mymysq
     package main
 
     import (
-    	"database/sql"
-    	"fmt"
-    	"github.com/JamesStewy/go-mysqldump"
-    	"github.com/ziutek/mymysql/godrv"
-    	"time"
+        "database/sql"
+        "fmt"
+
+        "github.com/JamesStewy/go-mysqldump"
+        "github.com/go-sql-driver/mysql"
     )
 
     func main() {
-        // Register the mymysql driver
-        godrv.Register("SET NAMES utf8")
-
         // Open connection to database
-        db, err := sql.Open("mymysql", "tcp:host:port*database/user/password")
-    	if err != nil {
-            fmt.Println("Error opening databse:", err)
+        config := mysql.NewConfig()
+        config.User = "your-user"
+        config.Passwd = "your-pw"
+        config.DBName = "your-db"
+        config.Net = "tcp"
+        config.Addr = "your-hostname:your-port"
+
+        dumpDir := "dumps"  // you should create this directory
+        dumpFilenameFormat := fmt.Sprintf("%s-20060102T150405", dbname)   // accepts time layout string and add .sql at the end of file
+
+        db, err := sql.Open("mysql", config.FormatDNS())
+        if err != nil {
+            fmt.Println("Error opening database: ", err)
             return
         }
 
         // Register database with mysqldump
-        dumper, err := mysqldump.Register(db, "dumps", time.ANSIC)
+        dumper, err := mysqldump.Register(db, dumpDir, dumpFilenameFormat)
         if err != nil {
-        	fmt.Println("Error registering databse:", err)
-        	return
+            fmt.Println("Error registering databse:", err)
+            return
         }
 
         // Dump database to file
-        err = dumper.Dump()
+        resultFilename, err := dumper.Dump()
         if err != nil {
-        	fmt.Println("Error dumping:", err)
-        	return
+            fmt.Println("Error dumping:", err)
+            return
         }
+        fmt.Printf("File is saved to %s", resultFilename)
 
-        // Close dumper and connected database
+        // Close dumper, connected database and file stream.
         dumper.Close()
     }
 */

dump.go

@@ -12,13 +12,14 @@ import (
 	"time"
 )
 
-type table struct {
-	Name   string
-	SQL    string
-	Values string
-}
+/*Data struct to configure dump behavior
+
+ * Out:          Stream to wite to
+
+ * Connection:   Database connection to dump
 
-// Data struct to configure dump behavior
+ * IgnoreTables: Mark sensitive tables to ignore
+ */
 type Data struct {
 	Out          io.Writer
 	Connection   *sql.DB
@@ -31,6 +32,12 @@ type Data struct {
 	wg         sync.WaitGroup
 }
 
+type table struct {
+	Name   string
+	SQL    string
+	Values string
+}
+
 type metaData struct {
 	DumpVersion   string
 	ServerVersion string

mysqldump.go

@@ -53,7 +53,7 @@ func Dump(db *sql.DB, out io.Writer) error {
 }
 
 // Close the dumper.
-// Will also close the database the dumper is connected to.
+// Will also close the database the dumper is connected to as well as the out stream if it is a *os.File.
 //
 // Not required.
 func (d *Data) Close() error {