Skip to content

Commit

Permalink
fix(proto): update readme (#44)
Browse files Browse the repository at this point in the history
  • Loading branch information
FloppyDisck authored Nov 26, 2024
2 parents f8e7ae6 + f577d44 commit b5cb961
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/proto/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "archway-proto"
version = "0.2.0"
version = "0.2.1"
edition = "2021"
description = "Rust build of Archway's ProtoBuf definitions"
authors.workspace = true
Expand Down
19 changes: 15 additions & 4 deletions packages/proto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,47 @@ Rust build of Archway's ProtoBuf definitions.

This package can be used both in CosmWasm smart contracts and gRPC clients.
It is based on the [`cosmos-sdk-proto v0.18.0`][cosmos-rust]
crate to provide the Cosmos SDK `v0.45.x` messages and follows the same feature
crate to provide the Cosmos SDK messages through the
`cosmos-sdk-proto` crate and follows the same feature
definitions, with the `tonic` gRPC clients enabled by default.

## Usage

### In CosmWasm smart contracts

```toml
archway-proto = { version = "0.1.0", default-features = false, features = ["cosmwasm"] }
archway-proto = { version = "0.2.1", default-features = false, features = ["cosmwasm"] }
```

### For the gRPC client functionality (won't work in CosmWasm)

```toml
archway-proto = "0.1.0"
archway-proto = "0.2.1"
```

## License

This project is licensed under the Apache-2.0 License - see the [NOTICE][notice-link] and [LICENSE][license-link] files for details.
This project is licensed under the Apache-2.0 License - see the [NOTICE][notice-link] and [LICENSE][license-link] files
for details.

[//]: # "badges"

[crate-image]: https://buildstats.info/crate/archway-proto

[crate-link]: https://crates.io/crates/archway-proto

[docs-image]: https://docs.rs/archway-proto/badge.svg

[docs-link]: https://docs.rs/archway-proto/

[license-image]: https://img.shields.io/github/license/archway-network/arch3.rs?label=License&logo=opensourceinitiative&logoColor=white&color=informational

[license-link]: https://github.com/archway-network/arch3.rs/blob/main/LICENSE

[rustc-image]: https://img.shields.io/badge/rustc-1.70+-blue.svg?logo=rust&logoColor=white&color=informational

[//]: # "links"

[cosmos-rust]: https://github.com/cosmos/cosmos-rust

[notice-link]: https://github.com/archway-network/arch3.rs/blob/main/NOTICE

0 comments on commit b5cb961

Please sign in to comment.