Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: add Platform Support section #981

Merged
merged 4 commits into from
Feb 7, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,32 @@
# go-mysql

A pure go library to handle MySQL network protocol and replication as used by MySQL and MariaDB.
A pure Go library to handle MySQL network protocol and replication as used by MySQL and MariaDB.

![semver](https://img.shields.io/github/v/tag/go-mysql-org/go-mysql)
![example workflow](https://github.com/go-mysql-org/go-mysql/actions/workflows/ci.yml/badge.svg)
![gomod version](https://img.shields.io/github/go-mod/go-version/go-mysql-org/go-mysql/master)
[![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)

## Platform Support

As a pure Go library, this project follows [Go's minimum requirements](https://go.dev/wiki/MinimumRequirements).

This library has been tested or deployed on the following operating systems and architectures:

| Operating System | Architecture | Runtime Supported | CI | Notes |
|------------------|--------------|-------------------|----|--------------------------------------------------------------------------------------------------------------------------------|
| Linux | amd64 | ✅ | ✅ | Check GitHub Actions of this project. |
| 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/). |
| Linux | arm64 | ✅ | ❌ | Deployed in a production environment of a user. |
| FreeBSD | amd64 | ✅ | ❌ | Sporadically tested by developers. |

Other platforms supported by Go may also work, but they have not been verified. Feel free to report your test results.

This library is not compatible with [TinyGo](https://tinygo.org/).

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

This library uses [Changelog](CHANGELOG.md).

---
# Content
Expand Down
Loading