diff --git a/README.md b/README.md index b4b63ba..a788b95 100644 --- a/README.md +++ b/README.md @@ -21,18 +21,26 @@ Sandbox API Repository to describe, develop, document, and test the RegionDevice * Describe, develop, document and test the APIs (with 1-2 Telcos) * Started: December 2023 + + + ## Release Information - - - - * **NEW**: Public release [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) with region-device-count v0.2.0 is now available. - * API definition **with inline documentation**: + +> [!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 [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) (Fall25), with the following API versions: + * **region-device-count v0.2.0** [[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.2/code/API_definitions/region-device-count.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) - + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml) +* The latest public release is always available here: https://github.com/camaraproject/RegionDeviceCount/releases/latest +* Other releases of this repository are available in https://github.com/camaraproject/RegionDeviceCount/releases * For changes see [CHANGELOG.md](https://github.com/camaraproject/RegionDeviceCount/blob/main/CHANGELOG.md) +_The above section is automatically synchronized by CAMARA project-administration._ + + ## Contributing * Meetings are held virtually * Schedule: Bi-Weekly on Fridays 11:00 CET/CEST / 09:00 UTC