Updated Readme & Enabled release-plz (#4)

* Updated Readme.

Signed-off-by: Marvin Hansen <marvin.hansen@gmail.com>

* Enabled relase-plz

Signed-off-by: Marvin Hansen <marvin.hansen@gmail.com>

---------

Signed-off-by: Marvin Hansen <marvin.hansen@gmail.com>

.github/workflows/rust-release.yml

@@ -26,8 +26,8 @@ jobs:
  fetch-depth: 0 # necessary to determine the next version and build the changelog.
  - name: Install Rust toolchain
  uses: dtolnay/rust-toolchain@stable
-# - name: Run release-plz
-# uses: MarcoIeni/release-plz-action@v0.5
-# env:
-# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-# CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+ - name: Run release-plz
+ uses: MarcoIeni/release-plz-action@v0.5
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

README.md

@@ -45,34 +45,19 @@ For detailed usage and more information, check out the documentation: https://do
 
 ## Install ProtonClient
 
-Add the following to your Cargo.toml:
+Add the proton client to your project by running in a terminal:
 
 ```
-[dependencies]
-proton_client = { git = "https://github.com/timeplus-io/proton-rust-client.git" }
+cargo add proton_client
 ```
 
-[//]: # (AFTER the release of the package on crates.io)
-
-[//]: # (Add the proton client to your project by running in a terminal:)
-
-[//]: # ()
-[//]: # (```)
-
-[//]: # (cargo add proton_client)
-
-[//]: # (```)
-
-[//]: # ()
-[//]: # (of by adding the following to your Cargo.toml:)
+or by adding the following to your Cargo.toml:
 
-[//]: # (```)
-
-[//]: # ([dependencies])
-
-[//]: # (proton_client = { version = "0.1.0"})
+```
+[dependencies]
 
-[//]: # (```)
+proton_client = { version = "0.1.0"}
+```
 
 
 ## Use ProtonClient