Adding a compatibility matrix (#43)

Signed-off-by: Vacha Shah <[email protected]>

Author: VachaShah

.github/workflows/integration.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         # 1.0.1 is skipped because it doesn't have a tag in OpenSearch repo, we can't check out to compile plugins
-        version: [1.3.0, 1.2.4, 1.2.3, 1.2.2, 1.2.1, 1.2.0, 1.1.0, 1.0.0]
+        version: [1.3.1, 1.3.0, 1.2.4, 1.2.3, 1.2.2, 1.2.1, 1.2.0, 1.1.0, 1.0.0]
 
     steps:
         # Due to https://github.com/opensearch-project/project-website/issues/737

COMPATIBILITY.md

@@ -0,0 +1,18 @@
+- [Compatibility with OpenSearch](#compatibility-with-opensearch)
+
+## Compatibility with OpenSearch
+
+The below matrix shows the compatibility of the `opensearch-net` with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch). Currently this client is in a pre-release phase. The below matrix shows compatibility for the upcoming version.
+
+| OpenSearch Version | Client Version |
+| --- | --- |
+| 1.0.0 | 1.0.0 |
+| 1.0.1 | 1.0.0 |
+| 1.1.0 | 1.0.0 |
+| 1.2.0 | 1.0.0 |
+| 1.2.1 | 1.0.0 |
+| 1.2.2 | 1.0.0 |
+| 1.2.3 | 1.0.0 |
+| 1.2.4 | 1.0.0 |
+| 1.3.0 | 1.0.0 |
+| 1.3.1 | 1.0.0 |

README.md

@@ -11,6 +11,7 @@
   - [Project Resources](#project-resources)
   - [OSC](#osc)
   - [Getting Started](#getting-started)
+  - [Compatibility with OpenSearch](#compatibility-with-opensearch)
   - [Code of Conduct](#code-of-conduct)
   - [License](#license)
   - [Copyright](#copyright)
@@ -44,6 +45,10 @@ OSC is the official high-level .NET client of [OpenSearch](https://github.com/op
 
 See [USER_GUIDE](USER_GUIDE.md) to get started with the .NET client.
 
+## Compatibility with OpenSearch
+
+See [COMPATIBILITY](COMPATIBILITY.md).
+
 ## Code of Conduct
 
 This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.