docs(chore): add binary compat table (csv/plugin-cli)

fixes #60
pact-foundation · May 20, 2024 · 2a962be · 2a962be
1 parent e17144f
commit 2a962be
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/cli/README.md b/cli/README.md
@@ -231,3 +231,22 @@ Executable is built using `cargo`.
 ### Requirements
 
 Requires Rust 1.61 or later.
+
+## Compatibility
+
+<details><summary>Supported Platforms</summary>
+
+| OS      | Architecture | Supported  | Pact Plugin CLI Version |
+| ------- | ------------ | ---------  | ---------------- |
+| OSX     | x86_64       | ✅         | All              |
+| Linux   | x86_64       | ✅         | All              |
+| Windows | x86_64       | ✅         | All              |
+| OSX     | arm64        | ✅         | All              |
+| Linux   | arm64        | ✅         | >=0.0.0          |
+| Windows | arm64        | ✅         | >=0.1.2          |
+| Alpine  | x86_64       | ✅         | >=0.1.2          |
+| Alpine  | arm64        | ✅         | >=0.1.2          |
+
+_Note:_ From v0.1.2, Linux executables are statically built with `musl` and as designed to work against `glibc` (eg, Debian) and `musl` (eg, Alpine) based distos.
+
+</details>
diff --git a/plugins/csv/README.md b/plugins/csv/README.md
@@ -56,3 +56,22 @@ Without headers:
   "column:3": "matching(datetime, 'yyyy-MM-dd','2000-01-01')"
 }
 ```
+
+## Compatibility
+
+<details><summary>Supported Platforms</summary>
+
+| OS      | Architecture | Supported  | Pact CSV Plugin Version |
+| ------- | ------------ | ---------  | ---------------- |
+| OSX     | x86_64       | ✅         | All              |
+| Linux   | x86_64       | ✅         | All              |
+| Windows | x86_64       | ✅         | All              |
+| OSX     | arm64        | ✅         | >=0.0.1          |
+| Linux   | arm64        | ✅         | >=0.0.4          |
+| Windows | arm64        | ✅         | >=0.0.6          |
+| Alpine  | x86_64       | ✅         | >=0.0.6          |
+| Alpine  | arm64        | ✅         | >=0.0.6          |
+
+_Note:_ From v0.0.6, Linux executables are statically built with `musl` and as designed to work against `glibc` (eg, Debian) and `musl` (eg, Alpine) based distos.
+
+</details>