diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 272b5770..f8accba9 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -7,7 +7,7 @@ The Flipt client-side SDKs are currently broken down into two main implementatio - [FFI](#ffi) - [WebAssembly](#webassembly) -You're use case will determine which implementation is best for you. The FFI implementation is designed to be embedded in native language client SDKs, while the WebAssembly implementation is designed to be embedded in client-side SDKs that runs in the browser. +Your use case will determine which implementation is best for you. The FFI implementation is designed to be embedded in native language client SDKs, while the WebAssembly implementation is designed to be embedded in client-side SDKs that run in the browser. ## FFI diff --git a/README.md b/README.md index 1470bdf4..c9a46873 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ There are two versions of the client SDKs: The [Foreign Function Interface (FFI)](https://en.wikipedia.org/wiki/Foreign_function_interface) versions of the client SDKs are currently available. > [!IMPORTANT] -> Our FFI SDKs currently only work with OSes that use the `glibc` C library. We are working on adding support for other OSes that use `musl` such as Alpine Linux. See [this issue](https://github.com/flipt-io/flipt-client-sdks/issues/141) for more information. +> Our FFI SDKs fully support OSes that use the `glibc` implementation of the C standard library. We have beta support for versions of the SDKs that use the `musl` C library. See [this issue](https://github.com/flipt-io/flipt-client-sdks/issues/141) for which SDKs have versions that support `musl`. ### Supported Architectures diff --git a/flipt-client-go/README.md b/flipt-client-go/README.md index 34599351..8f52f7f8 100644 --- a/flipt-client-go/README.md +++ b/flipt-client-go/README.md @@ -1,6 +1,7 @@ # Flipt Client Go -[![Client tag](https://img.shields.io/github/v/tag/flipt-io/flipt-client-go?label=latest)](https://github.com/flipt-io/flipt-client-go) +[![Client tag](https://img.shields.io/github/v/tag/flipt-io/flipt-client-go?filter=v*&label=flipt-client-go)](https://github.com/flipt-io/flipt-client-go) +[![Client tag (musl)](https://img.shields.io/github/v/tag/flipt-io/flipt-client-go?filter=musl-v*&label=flipt-client-go-musl)](https://github.com/flipt-io/flipt-client-go) [![Go Reference](https://pkg.go.dev/badge/go.flipt.io/flipt-client.svg)](https://pkg.go.dev/go.flipt.io/flipt-client) The `flipt-client-go` library contains the Go source code for the Flipt [client-side evaluation](https://www.flipt.io/docs/integration/client) client. @@ -16,10 +17,25 @@ go get go.flipt.io/flipt-client This SDK currently supports the following OSes/architectures: - Linux x86_64 +- Linux x86_64 (musl) - Linux arm64 +- Linux arm64 (musl) - MacOS x86_64 - MacOS arm64 + +### Glibc vs Musl + +Most Linux distributions use [Glibc](https://en.wikipedia.org/wiki/Glibc), but some distributions like Alpine Linux use [Musl](https://en.wikipedia.org/wiki/Musl). If you are using Alpine Linux, you will need to install the `musl` tagged version of the client. + +Example: + +```bash +go install go.flipt.io/flipt-client@musl-v0.0.1 +``` + +See [flipt-client-sdks #141](https://github.com/flipt-io/flipt-client-sdks/issues/141) for more information. + ## Usage In your Go code you can import this client and use it as so: