Skip to content

Commit ed283c2

Browse files
authored
docs: add alpha notice and update docs (#173)
* docs: add alpha notice Signed-off-by: mikeee <[email protected]> * docs: bump rust required version Signed-off-by: mikeee <[email protected]> * docs: add discord social channel Signed-off-by: mikeee <[email protected]> * docs: fix missing brace Signed-off-by: Mike Nguyen <[email protected]> --------- Signed-off-by: mikeee <[email protected]> Signed-off-by: Mike Nguyen <[email protected]>
1 parent c6048ef commit ed283c2

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# Dapr SDK for Rust
1+
# Dapr SDK for Rust (Alpha)
22

33
[![Crates.io][crates-badge]][crates-url]
44
[![Build Status][actions-badge]][actions-url]
5+
[![discord][discord-badge]][discord-url]
56
[![License: Apache 2.0][apache-badge]][apache-url]
67
[![FOSSA Status][fossa-badge]][fossa-url]
78

@@ -13,17 +14,36 @@
1314
[actions-url]: https://github.com/dapr/rust-sdk/actions?query=workflow%3Adapr-rust-sdk
1415
[fossa-badge]: https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fdapr%2Frust-sdk.svg?type=shield
1516
[fossa-url]: https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fdapr%2Frust-sdk?ref=badge_shield
16-
17-
⚠ Work in Progress ⚠
17+
[discord-badge]: https://img.shields.io/discord/778680217417809931
18+
[discord-url]: https://discord.com/channels/778680217417809931/778680217417809934
1819

1920
Dapr is a portable, event-driven, serverless runtime for building distributed applications across cloud and edge.
2021

2122
- [dapr.io](https://dapr.io)
2223
- [@DaprDev](https://twitter.com/DaprDev)
2324

25+
## Alpha
26+
27+
This SDK is currently in Alpha. Work is underway to bring forward a stable
28+
release and will likely involve breaking changes.
29+
- Documentation is incomplete.
30+
- Not all building blocks are currently implemented.
31+
- There may be bugs.
32+
- The SDK does not have complete test coverage.
33+
34+
The maintainers commit to resolving any issues that arise and bringing this SDK
35+
to a stable release. With this in mind, the SDK will follow the norms and
36+
conventions of a stable SDK so far as is possible.
37+
38+
This SDK will be accounted for as a part of the release process. Support for
39+
the latest runtime release is targeted but not guaranteed.
40+
41+
The main tenet of development will be stability and functionality that improves
42+
resiliency.
43+
2444
## Prerequisites
2545

26-
Ensure you have Rust version 1.40 or higher installed. If not, install Rust [here](https://www.rust-lang.org/tools/install).
46+
Ensure you have Rust version 1.56 or higher installed. If not, install Rust [here](https://www.rust-lang.org/tools/install).
2747

2848
You will also need to install [protoc](https://github.com/protocolbuffers/protobuf#protobuf-compiler-installation).
2949

@@ -77,3 +97,9 @@ By default, the script fetches the latest proto updates from the master branch o
7797
```bash
7898
./update-protos.sh -v v1.12.0
7999
```
100+
101+
### Contact Us
102+
Reach out with any questions you may have and we'll be sure to answer them as
103+
soon as possible!
104+
105+
[![Discord Banner](https://discord.com/api/guilds/778680217417809931/widget.png?style=banner2)](https://aka.ms/dapr-discord)

0 commit comments

Comments
 (0)