From 626e4bab14810b8062245ea7385dde6bb92e8b64 Mon Sep 17 00:00:00 2001 From: lance6716 Date: Fri, 7 Feb 2025 13:26:42 +0800 Subject: [PATCH 1/3] README: add Platform Support section Signed-off-by: lance6716 --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 761c3f315..cdfd07ae3 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,16 @@ A pure go library to handle MySQL network protocol and replication as used by My ![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 + +This project has been tested or deployed on the following operating systems and architectures: + +| Operating System | Architecture | Supported | CI | Notes | +|------------------|--------------|-----------|----|------------------------------------------------------------------------------------------------------------------------| +| Linux | amd64 | ✅ | ✅ | Check GitHub Actions of this project | +| Linux | s390x | ✅ | ✅ | A daily CI runs on s390x VM, supported by [IBM Z and LinuxOne Community](https://www.ibm.com/community/z/open-source/) | +| Linux | arm64 | ✅ | ❌ | Deployed in a production environment of a user | + ## Changelog This repo uses [Changelog](CHANGELOG.md). From c917708bb6006430677e10f5b3bd04c4cccd4d84 Mon Sep 17 00:00:00 2001 From: lance6716 Date: Fri, 7 Feb 2025 21:51:25 +0800 Subject: [PATCH 2/3] address comment Signed-off-by: lance6716 --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cdfd07ae3..9c94068af 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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) @@ -9,13 +9,20 @@ A pure go library to handle MySQL network protocol and replication as used by My ## Platform Support -This project has been tested or deployed on the following operating systems and architectures: +As a pure Go library, this project follows [Go's minimum requirements](https://go.dev/wiki/MinimumRequirements). -| Operating System | Architecture | Supported | CI | Notes | -|------------------|--------------|-----------|----|------------------------------------------------------------------------------------------------------------------------| -| Linux | amd64 | ✅ | ✅ | Check GitHub Actions of this project | -| Linux | s390x | ✅ | ✅ | A daily CI runs on s390x VM, supported by [IBM Z and LinuxOne Community](https://www.ibm.com/community/z/open-source/) | -| Linux | arm64 | ✅ | ❌ | Deployed in a production environment of a user | +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). From 3406f1ec2f3bb90e87f49f5b645fabd949d8afaa Mon Sep 17 00:00:00 2001 From: lance6716 Date: Fri, 7 Feb 2025 21:53:23 +0800 Subject: [PATCH 3/3] refine Signed-off-by: lance6716 --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c94068af..8cdfd6d90 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This library has been tested or deployed on the following operating systems and | Operating System | Architecture | Runtime Supported | CI | Notes | |------------------|--------------|-------------------|----|--------------------------------------------------------------------------------------------------------------------------------| -| Linux | amd64 | ✅ | ✅ | Check GitHub Actions of this project | +| 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. | @@ -25,7 +25,8 @@ Other platforms supported by Go may also work, but they have not been verified. This library is not compatible with [TinyGo](https://tinygo.org/). ## Changelog -This repo uses [Changelog](CHANGELOG.md). + +This library uses [Changelog](CHANGELOG.md). --- # Content