From b8c20077ff0c2111671d229be1c7027f8ce072f7 Mon Sep 17 00:00:00 2001 From: Luca8991 Date: Tue, 17 Oct 2023 19:16:01 +0200 Subject: [PATCH] chore: Cargo.toml config and readme --- .github/workflows/release.yml | 2 +- Cargo.lock | 2 +- Cargo.toml | 4 ++-- README.md | 14 +++----------- src/ic-websocket-cdk/Cargo.toml | 7 +++++-- 5 files changed, 12 insertions(+), 17 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1d2ee59..c79ab53 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -28,7 +28,7 @@ jobs: run: | rustup target add wasm32-unknown-unknown cargo publish -p ic-websocket-cdk - echo "version=v$(cargo pkgid -p ic-websocket-cdk | cut -d# -f2 | cut -d: -f2)" >> "$GITHUB_OUTPUT" + echo "version=$(cargo pkgid -p ic-websocket-cdk | cut -d# -f2 | cut -d: -f2)" >> "$GITHUB_OUTPUT" env: CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} diff --git a/Cargo.lock b/Cargo.lock index 1b527ef..7c1c91e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -840,7 +840,7 @@ dependencies = [ [[package]] name = "ic-websocket-cdk" -version = "0.1.0" +version = "0.1.1" dependencies = [ "base64", "candid", diff --git a/Cargo.toml b/Cargo.toml index 9d6ed72..1f905ed 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,11 +8,11 @@ members = [ edition = "2021" repository = "https://github.com/omnia-network/ic-websocket-cdk-rs" rust-version = "1.69.0" -description = "IC Websocket Canister Development Kit" +description = "IC Websocket CDK Rust workspace" license = "MIT" [workspace.dependencies] -ic-websocket-cdk = { path = "src/ic-websocket-cdk", version = "0.1.0" } +ic-websocket-cdk = { path = "src/ic-websocket-cdk" } candid = "0.9.3" ic-cdk = "0.10.0" diff --git a/README.md b/README.md index 963bc0d..cfc1509 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,12 @@ This repository contains the Rust implementation of IC WebSocket CDK. For more i ## Installation -You can install the library by adding the following line to your `Cargo.toml` file: +You can install the library by running: -```toml -ic-websocket-cdk = { git = "https://github.com/omnia-network/ic-websocket-cdk-rs", rev = "" } -``` - -For example, a valid installation line would be: - -```toml -ic-websocket-cdk = { git = "https://github.com/omnia-network/ic-websocket-cdk-rs", rev = "06fa3934743e9505f765660e62aba1bc47706d5a" } +```bash +cargo add ic-websocket-cdk ``` -It will also be available on crates.io soon. - ## Usage Refer to the [ic_websocket_example](https://github.com/omnia-network/ic_websocket_example) repository for an example of how to use the library. diff --git a/src/ic-websocket-cdk/Cargo.toml b/src/ic-websocket-cdk/Cargo.toml index bd366d5..3b1a0fb 100644 --- a/src/ic-websocket-cdk/Cargo.toml +++ b/src/ic-websocket-cdk/Cargo.toml @@ -1,11 +1,14 @@ [package] name = "ic-websocket-cdk" -version = "0.1.0" +version = "0.1.1" edition.workspace = true rust-version.workspace = true repository.workspace = true -description.workspace = true license.workspace = true +description = "IC Websocket Canister Development Kit" +homepage = "https://docs.rs/ic-websocket-cdk" +documentation = "https://docs.rs/ic-websocket-cdk" +readme = "../../README.md" exclude = [ "**/*.did", ]