Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(proto): update readme #44

Merged
merged 2 commits into from
Nov 26, 2024
Merged

fix(proto): update readme #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f917e00
update readme
FloppyDisck Nov 26, 2024
f577d44
code style fix
FloppyDisck Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

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
View file
Open in desktop
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
View file
Open in desktop
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
Loading