Skip to content

Commit 4780f53

Browse files
committed
Update README
1 parent 95109e7 commit 4780f53

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

+26-14
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,33 @@
11
# go-mysql
22

3-
A pure go library to handle MySQL network protocol and replication.
3+
A pure go library to handle MySQL network protocol and replication as used by MySQL and MariaDB.
44

55
![semver](https://img.shields.io/github/v/tag/go-mysql-org/go-mysql)
66
![example workflow](https://github.com/go-mysql-org/go-mysql/actions/workflows/ci.yml/badge.svg)
77
![gomod version](https://img.shields.io/github/go-mod/go-version/go-mysql-org/go-mysql/master)
8-
9-
## How to migrate to this repo
10-
To change the used package in your repo it's enough to add this `replace` directive to your `go.mod`:
11-
```
12-
replace github.com/siddontang/go-mysql => github.com/go-mysql-org/go-mysql v1.10.0
13-
```
14-
15-
v1.10.0 - is the last tag in repo, feel free to choose what you want.
8+
[![Go Reference](https://pkg.go.dev/badge/github.com/go-mysql-org/go-mysql.svg)](https://pkg.go.dev/github.com/go-mysql-org/go-mysql)
169

1710
## Changelog
1811
This repo uses [Changelog](CHANGELOG.md).
1912

2013
---
2114
# Content
22-
* [Replication](#replication)
23-
* [Incremental dumping](#canal)
24-
* [Client](#client)
25-
* [Fake server](#server)
26-
* [database/sql like driver](#driver)
15+
* [Replication](#replication) - Process events from a binlog stream.
16+
* [Incremental dumping](#canal) - Sync from MySQL to Redis, Elasticsearch, etc.
17+
* [Client](#client) - Simple MySQL client.
18+
* [Fake server](#server) - server side of the MySQL protocol, as library.
19+
* [database/sql like driver](#driver) - An alternative `database/sql` driver for MySQL.
20+
* [Migration](#how-to-migrate-to-this-repo) - Information for how to migrate if you used the old location of this project.
21+
22+
## Examples
23+
24+
The `cmd` directory contains example applications that can be build by running `make build` in the root of the project. The resulting binaries will be places in `bin/`.
25+
26+
- `go-binlogparser`
27+
- `go-canal`
28+
- `go-mysqlbinlog`
29+
- `go-mysqldump`
30+
- `go-mysqlserver`
2731

2832
## Replication
2933

@@ -492,6 +496,14 @@ func main() {
492496

493497
We pass all tests in https://github.com/bradfitz/go-sql-test using go-mysql driver. :-)
494498

499+
## How to migrate to this repo
500+
To change the used package in your repo it's enough to add this `replace` directive to your `go.mod`:
501+
```
502+
replace github.com/siddontang/go-mysql => github.com/go-mysql-org/go-mysql v1.10.0
503+
```
504+
505+
v1.10.0 - is the last tag in repo, feel free to choose what you want.
506+
495507
## Donate
496508

497509
If you like the project and want to buy me a cola, you can through:

0 commit comments

Comments
 (0)