diff --git a/README.md b/README.md index 4ea2fa9..eebbc06 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,25 @@ Sandbox API Repository to describe, develop, document, and test the NumberRecycl * Describe, develop, document, and test the API * Started: August 2024 + + + ## Release Information -* Note: Please be aware that the project will have 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. +> [!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/NumberRecycling/releases/tag/r2.2) (Fall25), with the following API versions: + * **number-recycling v0.2.0** + [[YAML]](https://github.com/camaraproject/NumberRecycling/blob/r2.2/code/API_definitions/number-recycling.yaml) + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml) +* The latest public release is always available here: https://github.com/camaraproject/NumberRecycling/releases/latest +* Other releases of this repository are available in https://github.com/camaraproject/NumberRecycling/releases +* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberRecycling/blob/main/CHANGELOG.md) -* **The latest public release of CAMARA Number Recycling is [r2.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.2)**. - - Contains the following API definitions **with inline documentation**: - - [YAML spec file](https://github.com/camaraproject/NumberRecycling/blob/r2.2/code/API_definitions/number-recycling.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors) -* **NEW**: Public release [r2.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.2) with number-recycling v0.2.0 is available. +_The above section is automatically synchronized by CAMARA project-administration._ + ## Contributing * Meetings of KnowYourCustomer Sub Project are held virtually