diff --git a/README.md b/README.md index 143f2f4a256..acd24ae5425 100644 --- a/README.md +++ b/README.md @@ -5,93 +5,51 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/fabric)](https://goreportcard.com/report/github.com/hyperledger/fabric) [![GoDoc](https://godoc.org/github.com/hyperledger/fabric?status.svg)](https://godoc.org/github.com/hyperledger/fabric) [![Documentation Status](https://readthedocs.org/projects/hyperledger-fabric/badge/?version=latest)](http://hyperledger-fabric.readthedocs.io/en/latest) - [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hyperledger/fabric/verify-build.yml?branch=main&label=build%20-%20main)](https://github.com/hyperledger/fabric/actions/workflows/verify-build.yml) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hyperledger/fabric/verify-build.yml?branch=release-2.5&label=build%20-%20release-2.5)](https://github.com/hyperledger/fabric/actions/workflows/verify-build.yml) [![Security vulnerability scan](https://github.com/hyperledger/fabric/actions/workflows/vulnerability-scan.yml/badge.svg?branch=main)](https://github.com/hyperledger/fabric/actions/workflows/vulnerability-scan.yml) - [![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/hyperledger/fabric)](https://github.com/hyperledger/fabric/blob/main/go.mod) [![GitHub Release](https://img.shields.io/github/v/release/hyperledger/fabric)](https://github.com/hyperledger/fabric/releases) +## Overview -This project is a _Graduated_ Hyperledger project. For more information on the history of this project, see the [Fabric wiki page](https://wiki.hyperledger.org/display/fabric). Information on what _Graduated_ entails can be found in -the [Hyperledger Project Lifecycle document](https://tsc.hyperledger.org/project-lifecycle.html). -Hyperledger Fabric is a platform for distributed ledger solutions underpinned -by a modular architecture delivering high degrees of confidentiality, -resiliency, flexibility, and scalability. It is designed to support pluggable -implementations of different components and accommodate the complexity and -intricacies that exist across the economic ecosystem. +**Hyperledger Fabric** is a **Graduated** project under the Hyperledger umbrella, designed for distributed ledger solutions. Its modular architecture provides high levels of confidentiality, resiliency, flexibility, and scalability. Hyperledger Fabric allows for pluggable implementations of various components, accommodating the complexities of different economic ecosystems. -Hyperledger Fabric delivers a uniquely elastic and extensible architecture, -distinguishing it from alternative blockchain solutions. Planning for the -future of enterprise blockchain requires building on top of a fully-vetted, -open-source architecture; Hyperledger Fabric is your starting point. +This platform offers a uniquely elastic and extensible architecture, setting it apart from other blockchain solutions. Building on a fully-vetted, open-source framework, Hyperledger Fabric is an ideal starting point for enterprise blockchain initiatives. ## Releases -Fabric provides periodic releases with new features -and improvements. Additionally, certain releases are designated as long-term -support (LTS) releases. Important fixes will be backported to the most recent -LTS release, and to the prior LTS release during periods of LTS release overlap. -For more details see the [LTS strategy](https://github.com/hyperledger/fabric-rfcs/blob/main/text/0005-lts-release-strategy.md). - -Current LTS release: -- [v2.5.x](https://hyperledger-fabric.readthedocs.io/en/release-2.5/whatsnew.html) +Hyperledger Fabric provides periodic releases with new features and improvements. Certain releases are designated as **Long-Term Support (LTS)**, ensuring that important fixes are backported during overlap periods. -Historic LTS releases: -- [v2.2.x](https://hyperledger-fabric.readthedocs.io/en/release-2.2/whatsnew.html) (maintenance ended in February 2024 with the delivery of v2.2.15) -- [v1.4.x](https://hyperledger-fabric.readthedocs.io/en/release-1.4/whatsnew.html) (maintenance ended in April 2021 with the delivery of v1.4.12) +### Current LTS Release: +- **[v2.5.x](https://hyperledger-fabric.readthedocs.io/en/release-2.5/whatsnew.html)** -Unless specified otherwise, all releases will be upgradable from the prior minor release. -Additionally, each LTS release is upgradable to the next LTS release. +### Historic LTS Releases: +- **[v2.2.x](https://hyperledger-fabric.readthedocs.io/en/release-2.2/whatsnew.html)** (maintenance ended February 2024) +- **[v1.4.x](https://hyperledger-fabric.readthedocs.io/en/release-1.4/whatsnew.html)** (maintenance ended April 2021) -Fabric releases and release notes can be found on the [GitHub releases page](https://github.com/hyperledger/fabric/releases). +For complete release notes, visit the **[GitHub releases page](https://github.com/hyperledger/fabric/releases)**. -Please visit the [GitHub issues with Epic label](https://github.com/hyperledger/fabric/labels/Epic) for our release roadmap. +## Documentation and Getting Started -## Documentation, Getting Started and Developer Guides +To familiarize yourself with Hyperledger Fabric, visit our comprehensive online documentation: +- **[Getting Started with v2.5](http://hyperledger-fabric.readthedocs.io/en/release-2.5/)** +- **[Previous Versions](http://hyperledger-fabric.readthedocs.io/en/release-2.4/)** -Please visit our -online documentation for -information on getting started using and developing with the fabric, SDK and chaincode: -- [v2.5](http://hyperledger-fabric.readthedocs.io/en/release-2.5/) -- [v2.4](http://hyperledger-fabric.readthedocs.io/en/release-2.4/) -- [v2.3](http://hyperledger-fabric.readthedocs.io/en/release-2.3/) -- [v2.2](http://hyperledger-fabric.readthedocs.io/en/release-2.2/) -- [v2.1](http://hyperledger-fabric.readthedocs.io/en/release-2.1/) -- [v2.0](http://hyperledger-fabric.readthedocs.io/en/release-2.0/) -- [v1.4](http://hyperledger-fabric.readthedocs.io/en/release-1.4/) -- [v1.3](http://hyperledger-fabric.readthedocs.io/en/release-1.3/) -- [v1.2](http://hyperledger-fabric.readthedocs.io/en/release-1.2/) -- [v1.1](http://hyperledger-fabric.readthedocs.io/en/release-1.1/) -- [main branch (development)](http://hyperledger-fabric.readthedocs.io/en/latest/) - -It's recommended for first-time users to begin by going through the Getting Started section of the documentation in order to gain familiarity with the Hyperledger Fabric components and the basic transaction flow. +We recommend that first-time users start with the **Getting Started** section to understand the components and basic transaction flow. ## Contributing -We welcome contributions to the Hyperledger Fabric project in many forms. -There’s always plenty to do! Check [the documentation on how to contribute to this project](http://hyperledger-fabric.readthedocs.io/en/latest/CONTRIBUTING.html) -for the full details. +We welcome contributions to Hyperledger Fabric in various forms. There’s always plenty to do! Check our [contribution guidelines](http://hyperledger-fabric.readthedocs.io/en/latest/CONTRIBUTING.html) for more details on how to get involved. ## Community -[Hyperledger Community](https://www.meetup.com/pro/hyperledger/) - -[Hyperledger mailing lists and archives](http://lists.hyperledger.org/) - -[Hyperledger Discord Chat](https://discord.com/invite/hyperledger) - -[Hyperledger Fabric Issue Tracking (GitHub Issues)](https://github.com/hyperledger/fabric/issues) - -[Hyperledger Fabric Wiki](https://wiki.hyperledger.org/display/Fabric) - -[Hyperledger Wiki](https://wiki.hyperledger.org/) - -[Hyperledger Code of Conduct](https://wiki.hyperledger.org/display/HYP/Hyperledger+Code+of+Conduct) - -[Community Calendar](https://wiki.hyperledger.org/display/HYP/Calendar+of+Public+Meetings) +Engage with the Hyperledger community: +- **[Hyperledger Community Meetup](https://www.meetup.com/pro/hyperledger/)** +- **[Mailing Lists and Archives](http://lists.hyperledger.org/)** +- **[Discord Chat](https://discord.com/invite/hyperledger)** +- **[Issue Tracking](https://github.com/hyperledger/fabric/issues)** -## License +## License -Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [LICENSE](LICENSE) file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/. +Hyperledger Fabric source code is available under the **Apache License, Version 2.0 (Apache-2.0)**, and documentation files are under the **Creative Commons Attribution 4.0 International License (CC-BY-4.0)**.