Skip to content

Commit

Permalink
add project maturity to README
Browse files Browse the repository at this point in the history
  • Loading branch information
plebhash committed Jun 10, 2024
1 parent 63b8d23 commit fff1e45
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ To get started with the Stratum V2 Reference Implementation (SRI), please follow

This guide provides all the necessary information on prerequisites, installation, and configuration to help you begin using, testing or contributing to SRI.

## 🏅 Project Maturity

Low-level crates (`protocols` directory) are considered **beta** software. Rust API Docs is a [work-in-progress](https://github.com/stratum-mining/stratum/issues/845), and the community should still expect small breaking API changes and patches.

Application-level crates (`roles` directory) are considered **alpha** software, and bugs are expected. They should be used as a guide on how to consume the low-level crates as dependencies.

## 🚀 Use Cases

The library is modular to address different use-cases and desired functionality. Examples include:
Expand Down

0 comments on commit fff1e45

Please sign in to comment.