Skip to content

Commit be3ac41

Browse files
committed
Update README.md
1 parent b66aaaf commit be3ac41

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A MySQL-Driver for Go's [database/sql](http://golang.org/pkg/database/sql) packa
88

99
[![Build Status](https://travis-ci.org/Go-SQL-Driver/MySQL.png?branch=master)](https://travis-ci.org/Go-SQL-Driver/MySQL) *(master branch)*
1010

11-
Note: `go get` doesn't install the master branch, but the tag `go1`, which is always checked before tagging!
11+
Note: `go get` doesn't install the `master` branch, but the tag `go1`, which build status is always checked before tagging!
1212

1313
---------------------------------------
1414
* [Features](#features)
@@ -28,7 +28,10 @@ Note: `go get` doesn't install the master branch, but the tag `go1`, which is al
2828
## Features
2929
* Lightweight and fast
3030
* Native Go implementation. No C-bindings, just pure Go
31-
* No unsafe operations *(type-conversions etc.)*
31+
* No unsafe operations *(e.g. type-conversions)*
32+
* Connections over TCP/IPv4, TCP/IPv6 or Unix Sockets
33+
* Automatic handling of broken connections
34+
* Automatic Connection-Pooling *(by database/sql package)*
3235

3336
## Requirements
3437
* Go 1 or higher (Go 1.0.3 or higher recommended)
@@ -37,16 +40,16 @@ Note: `go get` doesn't install the master branch, but the tag `go1`, which is al
3740
---------------------------------------
3841

3942
## Installation
40-
Simple install the package with the go tool from shell:
43+
Simple install the package to your [$GOPATH](http://code.google.com/p/go-wiki/wiki/GOPATH "GOPATH") with the [go tool](http://golang.org/cmd/go/ go command) from shell:
4144
```bash
4245
$ go get github.com/Go-SQL-Driver/MySQL
4346
```
4447
Make sure [Git is installed](http://git-scm.com/downloads) on your machine and in your system's `PATH`.
4548

4649
## Usage
47-
_Go MySQL Driver_ is an implementation of Go's `database/sql/driver` interface, so all you need to do is import the driver and open a new Database-Connection with the given driver.
50+
_Go MySQL Driver_ is an implementation of Go's `database/sql/driver` interface, so all you need to do is to import the driver and open a new database connection with the given driver.
4851

49-
Use `"mysql"` as `driverName` and a valid [DSN](#dsn-data-source-name) as `dataSourceName`
52+
Use `mysql` as `driverName` and a valid [DSN](#dsn-data-source-name) as `dataSourceName`
5053
```go
5154
import "database/sql"
5255
import _ "code.google.com/p/go-mysql-driver/mysql"
@@ -56,10 +59,12 @@ db, e := sql.Open("mysql", "user:password@/dbname?charset=utf8")
5659

5760
All further methods are listed here: http://golang.org/pkg/database/sql
5861

62+
[Examples are available in our Wiki](https://github.com/Go-SQL-Driver/MySQL/wiki/Examples "Go-MySQL-Driver Examples").
63+
5964

6065
## DSN (Data Source Name)
6166

62-
The Data Source Name has a common format, like e.g. [PEAR DB](http://pear.php.net/manual/en/package.database.db.intro-dsn.php) uses it, but without type-prefix:
67+
The Data Source Name has a common format, like e.g. [PEAR DB](http://pear.php.net/manual/en/package.database.db.intro-dsn.php) uses it, but without type-prefix (optional parts marked by squared brackets):
6368
```
6469
[username[:password]@][protocol[(address)]]/dbname[?param1=value1&paramN=valueN]
6570
```
@@ -80,7 +85,7 @@ If you do not want to preselect a database, leave `dbname` empty:
8085
```
8186

8287
### Password
83-
Passwords can consist of any character. Escaping is not necessary.
88+
Passwords can consist of any character. Escaping is **not** necessary.
8489

8590
### Protocol
8691
See [net.Dial](http://golang.org/pkg/net/#Dial) for more information which networks are available.
@@ -129,6 +134,9 @@ No Database preselected:
129134
user:password@/
130135
```
131136

137+
## Testing / Development
138+
To run the driver tests you may need to adjust the configuration. See [this Wiki-Page](https://github.com/Go-SQL-Driver/MySQL/wiki/Testing "Testing") for details.
139+
132140
---------------------------------------
133141

134142
## License

0 commit comments

Comments
 (0)