docs: add pact_ffi compat docs [skip ci]

closes #416
pact-foundation · Sep 6, 2024 · fe07b87 · fe07b87
1 parent effa4c7
commit fe07b87
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/rust/pact_ffi/README.md b/rust/pact_ffi/README.md
@@ -86,3 +86,22 @@ $ cmake --build .
 
 You can read about the architecture and design choices of this crate in
 [ARCHITECTURE.md](https://github.com/pact-foundation/pact-reference/blob/master/rust/pact_ffi/ARCHITECTURE.md).
+
+## Compatibility
+
+<details><summary>Supported Platforms</summary>
+
+| OS      | Architecture | Supported  | Pact FFI Version |
+| ------- | ------------ | ---------  | ---------------- |
+| OSX     | x86_64       | ✅         | All              |
+| Linux   | x86_64       | ✅         | All              |
+| Windows | x86_64       | ✅         | All              |
+| OSX     | arm64        | ✅         | [>=0.0.1](https://github.com/pact-foundation/pact-reference/releases/tag/libpact_ffi-v0.4.14)         |
+| Linux   | arm64        | ✅         | [>=0.3.6](https://github.com/pact-foundation/pact-reference/releases/tag/libpact_ffi-v0.3.6)         |         |
+| Windows | arm64        | ✅         | [>=0.4.14](https://github.com/pact-foundation/pact-reference/releases/tag/libpact_ffi-v0.4.14)         |
+| Alpine  | x86_64       | ✅         | static - [>=0.2.4](https://github.com/pact-foundation/pact-reference/releases/tag/libpact_ffi-v0.2.4)|
+| Alpine  | arm64        | ✅         | static - [>=0.4.15](https://github.com/pact-foundation/pact-reference/releases/tag/libpact_ffi-v0.4.15)|
+| Alpine  | x86_64       | ✅         | dynamic - [>=0.4.17](https://github.com/pact-foundation/pact-reference/releases/tag/libpact_ffi-v0.4.17)|
+| Alpine  | arm64        | ✅         | dynamic - [>=0.4.17](https://github.com/pact-foundation/pact-reference/releases/tag/libpact_ffi-v0.4.17)|
+
+</details>