Add badges for GoDoc and Go Report Card, add SQL query example

Author: justinclift

README.md

@@ -1,11 +1,24 @@
-A Go library for accessing and using SQLite databases on DBHub.io
+[![GoDoc](https://godoc.org/github.com/sqlitebrowser/go-dbhub?status.svg)](https://godoc.org/github.com/sqlitebrowser/go-dbhub)
+[![Go Report Card](https://goreportcard.com/badge/github.com/sqlitebrowser/go-dbhub)](https://goreportcard.com/report/github.com/sqlitebrowser/go-dbhub)
+
+A Go library for accessing and using SQLite databases stored remotely on DBHub.io
 
 *This is an early stage work in progress*
 
 What works now:
 
-* Running any read-only query (eg SELECT statements) on databases, returning the results
-* Listing the tables, views, indexes, and columns present in a database
+* Run read-only queries (eg SELECT statements) on databases, returning the results as JSON
+* List the names of tables, views, and indexes present in a database
+* List the columns present in a table or view, along with their details
+
+Still to do:
+
+* Tests for each function
+* Retrieve index details for a database
+* Return the list of available databases
+* Download a complete database
+* Upload a complete database
+* Retrieve database commit history details (size, branch, commit list, whatever else is useful)
 
 Example code:
 
@@ -27,6 +40,18 @@ fmt.Println("Tables:")
 for _, j := range tables {
     fmt.Printf("  * %s\n", j)
 }
+
+// Run a SQL query on the remote database
+r, err := db.Query("justinclift", "Join Testing.sqlite", false,
+    `SELECT table1.Name, table2.value
+        FROM table1 JOIN table2
+        USING (id)
+        ORDER BY table1.id`)
+if err != nil {
+    log.Fatal(err)
+}
+fmt.Printf("Query results:\n\t%v\n", r)
+fmt.Println()
 ```
 
 Output:
@@ -35,6 +60,9 @@ Output:
 Tables:
   * table1
   * table2
+
+Query results:
+        {[{[Foo 5]} {[Bar 10]} {[Baz 15]} {[Blumph 12.5000]} {[Blargo 8]} {[Batty 3]}]}
 ```
 
-Please try it out, and report any weirdness or bugs you encounter. :smile:
+Please try it out, submits PRs, and report any weirdness or bugs you encounter. :smile:

dbhub.go

@@ -1,16 +1,6 @@
 package dbhub
 
-// An library for working with databases on DBHub.io
-
-// TODO:
-//   * Add tests for each function
-//   * Create function(s) for listing indexes in the remote database
-//   * Create function to list columns in a table or view
-//   * Create function for returning a list of available databases
-//   * Create function for downloading complete database
-//   * Create function for uploading complete database
-//   * Create function for retrieving database details (size, branch, commit list, whatever else is useful)
-//   * Make a reasonable example application written in Go
+// A Go library for working with databases on DBHub.io
 
 import (
 	"encoding/base64"
@@ -21,7 +11,7 @@ import (
 )
 
 const (
-	LibraryVersion = "0.0.1"
+	version = "0.0.1"
 )
 
 // New creates a new DBHub.io connection object.  It doesn't connect to DBHub.io to do this.  Connection only occurs

http.go

@@ -19,7 +19,7 @@ func sendRequest(queryUrl string, data url.Values, returnStructure interface{})
 		return
 	}
 	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
-	req.Header.Set("User-Agent", fmt.Sprintf("go-dbhub v%s", LibraryVersion))
+	req.Header.Set("User-Agent", fmt.Sprintf("go-dbhub v%s", version))
 	resp, err = client.Do(req)
 	if err != nil {
 		return

types.go

@@ -1,14 +1,17 @@
 package dbhub
 
+// Connection is a simple container holding the API key and address of the DBHub.io server
 type Connection struct {
 	APIKey string `json:"api_key"`
 	Server string `json:"server"`
 }
 
+// ResultRow is used for returning the results of a SQL query as a slice of strings
 type ResultRow struct {
 	Fields []string
 }
 
+// Results is used for returning the results of a SQL query as a slice of strings
 type Results struct {
 	Rows []ResultRow
 }