From ab8293dc51ff16e56da13622a4a8c3d108e54b14 Mon Sep 17 00:00:00 2001 From: Yan Chen Date: Thu, 16 Nov 2023 09:51:49 -0800 Subject: [PATCH] update metadata --- Changelog.md | 2 +- rust/README.md | 5 ++++- rust/candid_parser/Cargo.toml | 2 +- rust/candid_parser/README.md | 9 +++++++++ rust/ic_principal/Cargo.toml | 1 + 5 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 rust/candid_parser/README.md diff --git a/Changelog.md b/Changelog.md index 83381c74..4b57fc6b 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,7 +1,7 @@ # Changelog -## Rust 0.10.0 +## 2023-11-16 (Rust 0.10.0) ### Breaking changes diff --git a/rust/README.md b/rust/README.md index 43044882..47113cb3 100644 --- a/rust/README.md +++ b/rust/README.md @@ -6,5 +6,8 @@ This directory hosts the following crates: -- `candid`, a serialization/deserialization library for Candid. You can seamlessly convert between Rust values and Candid in both binary and text format. +- `candid`, a serialization/deserialization library for Candid. You can seamlessly convert between Rust values and Candid in both binary and text format. If you are developing canisters on the Internet Computer, this should be the only crate you need. +- `candid_parser`, parser and binding generator for Candid. You will need this crate if you are developing tools for processing Candid data and types. +- `ic_principal`, Principal types used on the Internet Computer. The `candid` crate exports the types defined here. - `candid_derive`, an internal crate to convert Rust data types to Candid types. This crate should be considered as an implementation detail, and not be used directly, only via the `candid` crate. + diff --git a/rust/candid_parser/Cargo.toml b/rust/candid_parser/Cargo.toml index f386fd03..bee1a787 100644 --- a/rust/candid_parser/Cargo.toml +++ b/rust/candid_parser/Cargo.toml @@ -3,7 +3,7 @@ name = "candid_parser" version = "0.1.0" edition = "2021" authors = ["DFINITY Team"] -description = "Candid is an interface description language (IDL) for interacting with canisters running on the Internet Computer." +description = "Candid is an interface description language (IDL) for interacting with canisters running on the Internet Computer.This crates contains the parser and binding generator for Candid." homepage = "https://internetcomputer.org/docs/current/developer-docs/build/candid/candid-concepts" documentation = "https://docs.rs/candid_parser" repository = "https://github.com/dfinity/candid" diff --git a/rust/candid_parser/README.md b/rust/candid_parser/README.md new file mode 100644 index 00000000..68bbc61c --- /dev/null +++ b/rust/candid_parser/README.md @@ -0,0 +1,9 @@ +# Candid + +[Candid](https://github.com/dfinity/candid/tree/master/spec/Candid.md) is an interface description language (IDL) for interacting with _canisters_ (also known as _services_ or _actors_) running on the Internet Computer. + +The `candid_parser` crate contains the parser and binding generator for Candid. + +# Usage + +See [the docs here](https://docs.rs/candid_parser). diff --git a/rust/ic_principal/Cargo.toml b/rust/ic_principal/Cargo.toml index cc0801bc..1ccc0093 100644 --- a/rust/ic_principal/Cargo.toml +++ b/rust/ic_principal/Cargo.toml @@ -3,6 +3,7 @@ name = "ic_principal" version = "0.1.0" authors = ["DFINITY Stiftung "] edition = "2021" +description = "Principal type used on the Internet Computer." homepage = "https://internetcomputer.org/docs/current/references/id-encoding-spec" documentation = "https://docs.rs/ic_principal" repository="https://github.com/dfinity/candid"