chore: Cargo.toml config and readme

omnia-network · Oct 17, 2023 · b8c2007 · b8c2007
1 parent e9a494f
commit b8c2007
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 17 deletions.
diff --git 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
diff --git 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
@@ -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 = "<last-commit-hash-on-this-repo>" }
-```
-
-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
@@ -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",
 ]