Skip to content

Commit 531aef9

Browse files
committed
Add relevant badges to README
1 parent ec7870b commit 531aef9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Go-SQL-REST-Driver
22

3+
[![godoc](https://godoc.org/github.com/adaptant-labs/go-sql-rest-driver?status.svg)](http://godoc.org/github.com/adaptant-labs/go-sql-rest-driver)
4+
[![Build Status](https://travis-ci.com/adaptant-labs/go-sql-rest-driver.svg?branch=master)](https://travis-ci.com/adaptant-labs/go-sql-rest-driver)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/adaptant-labs/go-sql-rest-driver)](https://goreportcard.com/report/github.com/adaptant-labs/go-sql-rest-driver)
6+
37
A simple driver for Go's [database/sql](https://golang.org/pkg/database/sql/)
48
package for SQL over REST API endpoints, such as those found within the
59
RestAssured Query Gateway.
@@ -23,6 +27,13 @@ import _ "github.com/adaptant-labs/go-sql-rest-driver"
2327
db, err := sql.Open("restsql", "http://localhost:9000/query/v1/")
2428
```
2529

30+
## Online Documentation
31+
32+
Limited API documentation for the driver interface itself is provided through godoc, this can be accessed
33+
directly on the [package entry](https://godoc.org/github.com/adaptant-labs/go-sql-rest-driver)
34+
in the godoc package repository. In general, however, the [`database/sql`](https://golang.org/pkg/database/sql/)
35+
API should always be the main method of invocation.
36+
2637
## Acknowledgements
2738

2839
This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 731678.

0 commit comments

Comments
 (0)