Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

docs: add compatibility testing section to README

fredpenaa1e4d4f3887f
diff --git a/README.md b/README.md
index 5213dce8e4..e54e481272 100644
--- a/README.md
+++ b/README.md
@@ -116,6 +116,25 @@ const client = new S3Client({
});
```
+## Compatibility Testing
+
+> For full compatibility validation against real SDK and client workflows, use [floci-compatibility-tests](https://github.com/hectorvent/floci-compatibility-tests).
+
+This companion project provides a dedicated compatibility test suite for Floci across multiple SDKs and tooling scenarios, and is the recommended starting point when verifying integration behavior end to end.
+
+Available SDK test modules:
+
+| Module | Language / Tool | SDK / Client |
+|---|---|---|
+| `sdk-test-java` | Java 17 | AWS SDK for Java v2 |
+| `sdk-test-go` | Go | AWS SDK for Go v2 |
+| `sdk-test-node` | Node.js | AWS SDK for JavaScript v3 |
+| `sdk-test-python` | Python 3 | boto3 |
+| `sdk-test-rust` | Rust | AWS SDK for Rust |
+| `sdk-test-awscli` | Bash | AWS CLI v2 |
+
+The repository also includes compatibility validation for infrastructure tooling through `compat-cdk` (AWS CDK v2) and `compat-opentofu` (OpenTofu / Terraform-compatible workflows).
+
## Image Tags
| Tag | Description |