diff --git a/README.md b/README.md index 1950c9d..6859b93 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,23 @@ Sandbox API Repository to describe, develop, document, and test the IoTNetworkOp * Started: April 2025 + + + ## Release Information -* 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**. +> [!NOTE] +> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release. + +* **PREVIEW**: The latest pre-release is [r1.1](https://github.com/camaraproject/IoTNetworkOptimization/releases/tag/r1.1) (alpha), with the following API versions: + * **iot-network-optimization v0.1.0-alpha.1** + [[YAML]](https://github.com/camaraproject/IoTNetworkOptimization/blob/r1.1/code/API_definitions/iot-network-optimization.yaml) + [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml&nocors) + [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml) +* For changes see [CHANGELOG.md](https://github.com/camaraproject/IoTNetworkOptimization/blob/main/CHANGELOG.md) -* `NEW`: The latest pre-release is [r1.1](https://github.com/camaraproject/IoTNetworkOptimization/releases/tag/r1.1) with **iot-network-optimization v0.1.0-alpha.1** is available. - * version v0.1.0-alpha.1 of the **API iot-network-optimization** - available [here](https://github.com/camaraproject/IoTNetworkOptimization/tree/r1.1) - * API definitions **with inline documentation**: - * OpenAPI [YAML](https://github.com/camaraproject/IoTNetworkOptimizationn/blob/r1.1/code/API_definitions/iot-network-optimization.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/refs/tags/r1.1/code/API_definitions/iot-network-optimization.yaml&nocors) - * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/refs/tags/r1.1/code/API_definitions/iot-network-optimization.yaml) +_The above section is automatically synchronized by CAMARA project-administration._ + ## Contributing