Skip to content

Commit

Permalink
Add README to ibc-telemetry (#1045)
Browse files Browse the repository at this point in the history
* Use project readme for ibc-telemetry

* Fix keywords

* Add a README to the ibc-telemetry crate
  • Loading branch information
romac authored Jun 3, 2021
1 parent 33e1f14 commit 3b2c309
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
2 changes: 1 addition & 1 deletion telemetry/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.4.0"
edition = "2018"
license = "Apache-2.0"
readme = "README.md"
keywords = ["blockchain", "consensus", "cosmos", "ibc", "tendermint", "telemetry"]
keywords = ["cosmos", "ibc", "relayer", "telemetry"]
repository = "https://github.com/informalsystems/ibc-rs"
authors = ["Informal Systems <[email protected]>"]

Expand Down
42 changes: 42 additions & 0 deletions telemetry/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# IBC Telemetry

[![Crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
[![Build Status][build-image]][build-link]
[![End to End testing][e2e-image]][e2e-link]
[![Apache 2.0 Licensed][license-image]][license-link]
![Rust Stable][rustc-image]
![Rust 1.51+][rustc-version]

This is the repository for the IBC telemetry service for use in the Hermes IBC relayer.

See the [telemetry documentation][telemetry-doc] in the Hermes guide for more information.

## License

Copyright © 2021 Informal Systems Inc. and ibc-rs authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use the files in this repository except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


[//]: # (badges)

[crate-image]: https://img.shields.io/crates/v/ibc-telemetry.svg
[crate-link]: https://crates.io/crates/ibc-telemetry
[docs-image]: https://docs.rs/ibc-telemetry/badge.svg
[docs-link]: https://docs.rs/ibc-telemetry/

[build-image]: https://github.com/informalsystems/ibc-rs/workflows/Rust/badge.svg
[build-link]: https://github.com/informalsystems/ibc-rs/actions?query=workflow%3ARust
[e2e-image]: https://github.com/informalsystems/ibc-rs/workflows/End%20to%20End%20testing/badge.svg
[e2e-link]: https://github.com/informalsystems/ibc-rs/actions?query=workflow%3A%22End+to+End+testing%22
[telemetry-doc]: https://hermes.informal.systems/telemetry.html

[license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
[license-link]: https://github.com/informalsystems/ibc-rs/blob/master/LICENSE
[rustc-image]: https://img.shields.io/badge/rustc-stable-blue.svg
[rustc-version]: https://img.shields.io/badge/rustc-1.51+-blue.svg

0 comments on commit 3b2c309

Please sign in to comment.