Skip to content

Commit

Permalink
update metadata (#494)
Browse files Browse the repository at this point in the history
* update metadata

* Update rust/candid_parser/Cargo.toml

---------

Co-authored-by: Gabor Greif <[email protected]>
  • Loading branch information
chenyan-dfinity and ggreif authored Nov 16, 2023
1 parent 1c00b4a commit aeacf90
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Changelog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Changelog

## Rust 0.10.0
## 2023-11-16 (Rust 0.10.0)

### Breaking changes

Expand Down
5 changes: 4 additions & 1 deletion rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

2 changes: 1 addition & 1 deletion rust/candid_parser/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 crate contains the parser and the 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"
Expand Down
9 changes: 9 additions & 0 deletions rust/candid_parser/README.md
Original file line number Diff line number Diff line change
@@ -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).
1 change: 1 addition & 0 deletions rust/ic_principal/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "ic_principal"
version = "0.1.0"
authors = ["DFINITY Stiftung <[email protected]>"]
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"
Expand Down

0 comments on commit aeacf90

Please sign in to comment.