From d5aca1f30388441c93bd1fa634f9fa4f0531ca52 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Raynaud Date: Mon, 27 Nov 2023 11:15:53 +0100 Subject: [PATCH 1/2] Remove mention about unpublished mithril client crate in doc --- .../developer-docs/nodes/mithril-client-library.md | 12 ------------ .../developer-docs/nodes/mithril-client-library.md | 12 ------------ 2 files changed, 24 deletions(-) diff --git a/docs/website/root/manual/developer-docs/nodes/mithril-client-library.md b/docs/website/root/manual/developer-docs/nodes/mithril-client-library.md index dcc36a08460..1848e32f9c1 100644 --- a/docs/website/root/manual/developer-docs/nodes/mithril-client-library.md +++ b/docs/website/root/manual/developer-docs/nodes/mithril-client-library.md @@ -48,18 +48,6 @@ It is responsible for handling the different types of data certified by Mithril, ## Installation -:::caution - -Mithril client library has not yet been published on [crates.io](https://crates.io/), so you won't be able to follow the procedure below. The crate will be published soon. - -For now, you can experiment it by adding the dependency manually in the Cargo.toml of your project: - -```toml title="/Cargo.toml" -mithril-client = { git = "https://github.com/input-output-hk/mithril.git" } -``` - -::: - In your project, use `cargo` to add [mithril-client](https://crates.io/crates/mithril-client) crate as a dependency: ```bash diff --git a/docs/website/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client-library.md b/docs/website/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client-library.md index dcc36a08460..1848e32f9c1 100644 --- a/docs/website/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client-library.md +++ b/docs/website/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-client-library.md @@ -48,18 +48,6 @@ It is responsible for handling the different types of data certified by Mithril, ## Installation -:::caution - -Mithril client library has not yet been published on [crates.io](https://crates.io/), so you won't be able to follow the procedure below. The crate will be published soon. - -For now, you can experiment it by adding the dependency manually in the Cargo.toml of your project: - -```toml title="/Cargo.toml" -mithril-client = { git = "https://github.com/input-output-hk/mithril.git" } -``` - -::: - In your project, use `cargo` to add [mithril-client](https://crates.io/crates/mithril-client) crate as a dependency: ```bash From b390f5e4003eba578f7eeeb4fe013c38bb119025 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Raynaud Date: Mon, 27 Nov 2023 11:16:25 +0100 Subject: [PATCH 2/2] Add blog post about new mithril client library released --- ...3-11-27-mithril-client-library-released.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/website/blog/2023-11-27-mithril-client-library-released.md diff --git a/docs/website/blog/2023-11-27-mithril-client-library-released.md b/docs/website/blog/2023-11-27-mithril-client-library-released.md new file mode 100644 index 00000000000..40611cee18c --- /dev/null +++ b/docs/website/blog/2023-11-27-mithril-client-library-released.md @@ -0,0 +1,20 @@ +--- +title: Mithril client library is released! +authors: + - name: Mithril Team +tags: [spo, mithril client, library, crates.io] +--- + +### Mithril client library is open to developers on crates.io + +The Mithril team has published the first release (**v0.5.7)** of its [mithril-client](https://crates.io/crates/mithril-client) library on crates.io. + +The **Mithril client library** allows developers to use all the tooling necessary to manipulate Mithril certified types from a Mithril Aggregator directly in their (Rust) applications and to develop their own Mithril clients! + +Here are some useful documentation that can be used by developers: +- **Developer documentation**: https://docs.rs/mithril-client/0.5.7/mithril_client/ +- **Example of implementations**:https://github.com/input-output-hk/mithril/blob/main/mithril-client/examples/ +- **Mithril client repository**: https://github.com/input-output-hk/mithril/tree/main/mithril-client +- **Crates.io**: https://crates.io/crates/mithril-client + +Feel free to reach out to us on the [Discord channel](https://discord.gg/5kaErDKDRq) for questions and/or help.