Skip to content

Commit 0f8d049

Browse files
authored
README: add Platform Support section (#981)
* README: add Platform Support section Signed-off-by: lance6716 <[email protected]> * address comment Signed-off-by: lance6716 <[email protected]> * refine Signed-off-by: lance6716 <[email protected]> --------- Signed-off-by: lance6716 <[email protected]>
1 parent 0d261b3 commit 0f8d049

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
11
# go-mysql
22

3-
A pure go library to handle MySQL network protocol and replication as used by MySQL and MariaDB.
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)
88
[![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)
99

10+
## Platform Support
11+
12+
As a pure Go library, this project follows [Go's minimum requirements](https://go.dev/wiki/MinimumRequirements).
13+
14+
This library has been tested or deployed on the following operating systems and architectures:
15+
16+
| Operating System | Architecture | Runtime Supported | CI | Notes |
17+
|------------------|--------------|-------------------|----|--------------------------------------------------------------------------------------------------------------------------------|
18+
| Linux | amd64 ||| Check GitHub Actions of this project. |
19+
| Linux | s390x ||| A daily CI runs on an s390x VM, supported by the [IBM Z and LinuxONE Community](https://www.ibm.com/community/z/open-source/). |
20+
| Linux | arm64 ||| Deployed in a production environment of a user. |
21+
| FreeBSD | amd64 ||| Sporadically tested by developers. |
22+
23+
Other platforms supported by Go may also work, but they have not been verified. Feel free to report your test results.
24+
25+
This library is not compatible with [TinyGo](https://tinygo.org/).
26+
1027
## Changelog
11-
This repo uses [Changelog](CHANGELOG.md).
28+
29+
This library uses [Changelog](CHANGELOG.md).
1230

1331
---
1432
# Content

0 commit comments

Comments
 (0)