From 332df9422e9df52506b8b77b08d5491501afb3fe Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Fri, 23 Aug 2024 18:13:11 +0200 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8ef743b..2924048 100644 --- a/README.md +++ b/README.md @@ -16,19 +16,14 @@ Repository to describe, develop, document and test the Blockchain Public Address * Started: June 2023 ## Release Information - - - - - * [Latest Release](https://github.com/camaraproject/BlockchainPublicAddress/releases/latest) - * Release Information: Link to wiki - * 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**. - * **The first available release and version of Blockchain Public Address API is 0.1.0.** There are expected changes in upcoming releases. It is addressed for early implementations, but not a stable version yet. - * Release 0.1.0 of the API is available within the [release-0.1.0 branch](https://github.com/camaraproject/BlockchainPublicAddress/tree/release-0.1.0): - - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/BlockchainPublicAddress/blob/release-0.1.0/code/API_definitions/blockchain_public_address.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/release-0.1.0/code/API_definitions/blockchain_public_address.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/release-0.1.0/code/API_definitions/blockchain_public_address.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**. +* **The first initial release and version of Blockchain Public Address API is 0.1.0 and is available within the [release-0.1.0 branch](https://github.com/camaraproject/BlockchainPublicAddress/tree/release-0.1.0) ** There are expected changes in upcoming releases. It is addressed for early implementations, but not a stable version yet. +* API definition of Blockchain Public Address API is 0.1.0 (with inline documentation): + - OpenAPI [YAML spec file](https://github.com/camaraproject/BlockchainPublicAddress/blob/release-0.1.0/code/API_definitions/blockchain_public_address.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/release-0.1.0/code/API_definitions/blockchain_public_address.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/release-0.1.0/code/API_definitions/blockchain_public_address.yaml) +* All releases and pre-releases are available here https://github.com/camaraproject/BlockchainPublicAddress/releases +* For changes see [CHANGELOG.md](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md) ## Contributing * Meetings