Skip to content

Commit

Permalink
imp: update ibc-rs repo cover + small README adjustments (#885)
Browse files Browse the repository at this point in the history
  • Loading branch information
Farhad-Shabani authored Oct 2, 2023
1 parent 45b297f commit e8757aa
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 5 deletions.
6 changes: 6 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"default": true,
"MD013": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md013---line-length
"MD033": false, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033---inline-html
"MD041": false // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041---first-line-in-a-file-should-be-a-top-level-heading
}
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,32 @@
# ibc-rs
<div align="center">
<h1>ibc-rs</h1>
</div>

![banner](docs/static/img/ibc-rs-cover.svg)

<div align="center">
<div>

[![Cosmos ecosystem][cosmos-shield]][cosmos-link]

</div>
<div>

[![Docs][docs-image]][docs-link]
[![Build Status][build-image]][build-link]
[![Code Coverage][codecov-image]][codecov-link]
[![Apache 2.0 Licensed][license-image]][license-link]
![Rust Stable][rustc-image]
![Rust 1.60+][rustc-version]
![Lines of Code][loc-image]

</div>
</div>

Rust implementation of the Inter-Blockchain Communication (IBC) protocol. This project hosts
the `ibc` rust crate which defines the main data structures and on-chain logic for the IBC protocol.

See the [ibc](crates/ibc) crate's README.md for more detailed information on the `ibc` crate.
See the [ibc](crates/ibc/README.md) crate's README.md for more detailed information on the `ibc` crate.

## Contributing

Expand All @@ -26,9 +40,13 @@ See also [CONTRIBUTING.md](./CONTRIBUTING.md).

## Community calls

We run monthly community calls to update the community with current our direction and gather feedback on what to work on next. The community calls are also a platform for you to update everyone else with what you're working on, and find opportunities to collaborate.
We run monthly community calls to update the community with current our
direction and gather feedback on what to work on next. The community calls are
also a platform for you to update everyone else with what you're working on, and
find opportunities to collaborate.

Please join the [Google group](https://groups.google.com/g/ibc-rs-community) to receive a calendar invitation for the monthly meeting.
Please join the [Google group](https://groups.google.com/g/ibc-rs-community) to
receive a calendar invitation for the monthly meeting.

## Versioning

Expand Down Expand Up @@ -60,13 +78,13 @@ CONDITIONS OF ANY KIND, either express or implied. See the License for the speci
[build-link]: https://github.com/cosmos/ibc-rs/actions?query=workflow%3ARust
[codecov-image]: https://codecov.io/gh/cosmos/ibc-rs/branch/main/graph/badge.svg?token=wUm2aLCOu
[codecov-link]: https://codecov.io/gh/cosmos/ibc-rs
[loc-image]: https://tokei.rs/b1/github/cosmos/ibc-rs
[license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
[license-link]: https://github.com/cosmos/ibc-rs/blob/main/LICENSE
[rustc-image]: https://img.shields.io/badge/rustc-stable-blue.svg
[rustc-version]: https://img.shields.io/badge/rustc-1.60+-blue.svg

[//]: # (general links)
[ibc-rs]: https://github.com/cosmos/ibc-rs
[ibc]: https://github.com/cosmos/ibc
[ibc-go]: https://github.com/cosmos/ibc-go
[ibc-homepage]: https://cosmos.network/ibc
Expand Down
42 changes: 42 additions & 0 deletions docs/static/img/ibc-rs-cover.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e8757aa

Please sign in to comment.