Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
aelesbao committed Oct 14, 2023
1 parent af1e805 commit 1d1a258
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 6 deletions.
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
# Archway Bindings
# arch3.rs

CosmWasm bindings to interact with Archway's modules.
[![Build Status][build-image]][build-link]
[![Codacy Badge][codacy-image]][codacy-link]
[![Apache 2.0 Licensed][license-image]][license-link]
![MSRV][rustc-image]

## Usage
Rust SDK for Archway.

Please refer to the [example contract](https://github.com/archway-network/archway-bindings/tree/main/contracts/increment) for a full usage example.
## Packages

| Package | Version | Docs | Description |
|-------------------------------------------|:---------------------------------------------:|:-----------------------------------------------------:|:------------------------------------------------------|
| [`archway-bindings`](./packages/bindings) | [![crates.io][bindings-image]][bindings-link] | [![docs.rs][bindings-docs-image]][bindings-docs-link] | CosmWasm bindings to interact with Archway's modules. |
| [`archway-proto`](./packages/proto) | [![crates.io][proto-image]][proto-link] | [![docs.rs][proto-docs-image]][proto-docs-link] | Rust build of Archway's ProtoBuf definitions. |

## License

This project is licensed under the Apache-2.0 License - see the [LICENSE][license-link] file for details.

[//]: # "badges"
[build-image]: https://github.com/archway-network/arch3.rs/actions/workflows/check.yml/badge.svg
[build-link]: https://github.com/archway-network/arch3.rs/actions/workflows/check.yml
[codacy-image]: https://app.codacy.com/project/badge/Grade/6fedce8e3af541718dba59bde1f38375
[codacy-link]: https://app.codacy.com/gh/archway-network/arch3.rs/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
[license-image]: https://img.shields.io/github/license/archway-network/arch3.rs?label=License&logo=opensourceinitiative&logoColor=white
[license-link]: https://github.com/archway-network/arch3.rs/blob/main/LICENSE
[rustc-image]: https://img.shields.io/badge/rustc-1.70+-red.svg?logo=rust
[bindings-image]: https://img.shields.io/crates/v/archway-bindings.svg
[bindings-link]: https://crates.io/crates/archway-bindings
[bindings-docs-image]: https://docs.rs/archway-bindings/badge.svg
[bindings-docs-link]: https://docs.rs/archway-bindings/
[proto-image]: https://img.shields.io/crates/v/archway-proto.svg
[proto-link]: https://crates.io/crates/archway-proto
[proto-docs-image]: https://docs.rs/archway-proto/badge.svg
[proto-docs-link]: https://docs.rs/archway-proto/
28 changes: 27 additions & 1 deletion packages/bindings/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
# Archway Bindings

[![Crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
[![Apache 2.0 Licensed][license-image]][license-link]
![MSRV][rustc-image]

CosmWasm bindings to interact with Archway's modules.

## Usage

Please refer to the [example contract](https://github.com/archway-network/archway-bindings/tree/main/contracts/increment) for a full usage example.
Please refer to the [example contract] for a full usage example.

## Specs

The bindings follow the [specs] defined by the Archway Protocol.

## License

This project is licensed under the Apache-2.0 License - see the [LICENSE][license-link] file for details.

[//]: # "badges"
[crate-image]: https://buildstats.info/crate/archway-bindings
[crate-link]: https://crates.io/crates/archway-bindings
[docs-image]: https://docs.rs/archway-bindings/badge.svg
[docs-link]: https://docs.rs/archway-bindings/
[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

[//]: # "general links"
[example contract]: https://github.com/archway-network/arch3.rs/tree/main/contracts/increment
[specs]: https://github.com/archway-network/archway/blob/main/x/rewards/spec/08_wasm_bindings.md
23 changes: 22 additions & 1 deletion packages/proto/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Archway Proto

[![Crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
[![Apache 2.0 Licensed][license-image]][license-link]
![MSRV][rustc-image]

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`](https://github.com/cosmos/cosmos-rust)
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
definitions, with the `tonic` gRPC clients enabled by default.

Expand All @@ -20,3 +25,19 @@ archway-proto = { version = "0.1.0", default-features = false, features = ["cosm
```toml
archway-proto = "0.1.0"
```

## License

This project is licensed under the Apache-2.0 License - see the [LICENSE][license-link] file 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

0 comments on commit 1d1a258

Please sign in to comment.