Skip to content

Commit

Permalink
Readme + publish info
Browse files Browse the repository at this point in the history
  • Loading branch information
slinkydeveloper committed Jul 15, 2024
1 parent 6db416f commit 318b740
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
name = "restate-sdk-shared-core"
version = "0.0.1"
edition = "2021"
description = "SDK Shared core"
license = "MIT"
repository = "https://github.com/restatedev/sdk-shared-core"

[dependencies]
thiserror = "1.0.61"
Expand Down
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
# SDK Shared core

Shared core to build SDKs in various languages.
Shared core to build SDKs in various languages. Currently used by:

* [Python SDK](https://github.com/restatedev/sdk-python)

## Versions

This library follows [Semantic Versioning](https://semver.org/).

The compatibility with Restate is described in the following table:

| Restate Server\sdk-shared-core | 0.0/0.1 |
|--------------------------------|---------|
| 1.0 ||

## Development

You need the [Rust toolchain](https://rustup.rs/). To verify:

```
just verify
```

To release we use [cargo-release](https://github.com/crate-ci/cargo-release):

```
cargo release <VERSION>
```

0 comments on commit 318b740

Please sign in to comment.