diff --git a/README.md b/README.md index ee2c4a1..70259b3 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,26 @@ Sandbox API Repository to describe, develop, document, and test the Subscription * Describe, develop, document, and test the APIs * Started: August 2024 + + + ## Release Information - * **NEW**: Public release [r1.2](https://github.com/camaraproject/SubscriptionStatus/releases/tag/r1.2) with subscription-status v0.1.0 is now available. - * API definition **with inline documentation**: - [[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.2/code/API_definitions/subscription-status.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml) +> [!NOTE] +> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. +* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/SubscriptionStatus/releases/tag/r1.2) (Fall25), with the following API versions: + * **subscription-status v0.1.0** + [[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.2/code/API_definitions/subscription-status.yaml) + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml) +* The latest public release is always available here: https://github.com/camaraproject/SubscriptionStatus/releases/latest +* Other releases of this repository are available in https://github.com/camaraproject/SubscriptionStatus/releases * For changes see [CHANGELOG.md](https://github.com/camaraproject/SubscriptionStatus/blob/main/CHANGELOG.md) +_The above section is automatically synchronized by CAMARA project-administration._ + + ## Contributing * Meetings of Sub Project KnowYourCustomer are held virtually * Schedule: Bi-weekly, Tuesday, 09:00 CEST (07:00 UTC)