Skip to content

Commit 48c771f

Browse files
authored
docs: add test badges for java and rust (#602)
Signed-off-by: Night Owl <nightowl121@protonmail.com>
1 parent 135a0c3 commit 48c771f

File tree

1 file changed

+48
-27
lines changed

1 file changed

+48
-27
lines changed

README.md

+48-27
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,59 @@
33
[![Lines Of Code](https://img.shields.io/tokei/lines/github/icon-project/IBC-Integration?style=flat-square)](https://github.com/icon-project/IBC-Integration)
44
[![Version](https://img.shields.io/github/tag/icon-project/IBC-Integration.svg?style=flat-square)](https://github.com/icon-project/IBC-Integration)
55

6-
| Language | Code Coverage |
7-
| ----------------------------------- | ---------------------------------------------- |
8-
| [Java](./contracts/javascore) | [![Java Cov][java-cov-badge]][java-cov-link] |
9-
| [Rust](./contracts/cosmwasm-vm) | [![Rust Cov][rust-cov-badge]][rust-cov-link] |
6+
| Language | Code Coverage | Test |
7+
|---------------------------------|----------------------------------------------|-------------------------------------------------|
8+
| [Java](./contracts/javascore) | [![Java Cov][java-cov-badge]][java-cov-link] | [![Java Test][java-test-badge]][java-test-link] |
9+
| [Rust](./contracts/cosmwasm-vm) | [![Rust Cov][rust-cov-badge]][rust-cov-link] | [![Rust Test][rust-test-badge]][rust-test-link] |
1010

1111
[java-cov-link]: https://app.codecov.io/gh/icon-project/IBC-Integration/tree/main/contracts/javascore
12+
1213
[rust-cov-link]: https://app.codecov.io/gh/icon-project/IBC-Integration/tree/main/contracts/cosmwasm-vm
14+
1315
[java-cov-badge]: https://codecov.io/gh/icon-project/IBC-Integration/branch/main/graph/badge.svg?token=8KX6y8aGom&flag=java
16+
1417
[rust-cov-badge]: https://codecov.io/gh/icon-project/IBC-Integration/branch/main/graph/badge.svg?token=8KX6y8aGom&flag=rust
1518

19+
[java-test-badge]: https://github.com/icon-project/IBC-Integration/actions/workflows/java-contracts-test.yml/badge.svg
20+
21+
[java-test-link]: https://github.com/icon-project/IBC-Integration/actions/workflows/java-contracts-test.yml
22+
23+
[rust-test-badge]: https://github.com/icon-project/IBC-Integration/actions/workflows/basic-rust.yml/badge.svg
24+
25+
[rust-test-link]: https://github.com/icon-project/IBC-Integration/actions/workflows/basic-rust.yml
26+
1627
# IBC-Integration
17-
The Inter-Blockchain Communication protocol (IBC) is an end-to-end, connection-oriented, stateful protocol for reliable, ordered, and authenticated communication between heterogeneous blockchains arranged in an unknown and dynamic topology. xCall, a standard for generic cross-chain messaging along with IBC provides dynamic and coherent solution for inter-connected dapps.
1828

19-
Additional information on how IBC works can be found [here](https://ibc.cosmos.network/). and xCall spec is defined [here](https://github.com/icon-project/IIPs/blob/master/IIPS/iip-52.md)
29+
The Inter-Blockchain Communication protocol (IBC) is an end-to-end, connection-oriented, stateful protocol for reliable,
30+
ordered, and authenticated communication between heterogeneous blockchains arranged in an unknown and dynamic topology.
31+
xCall, a standard for generic cross-chain messaging along with IBC provides dynamic and coherent solution for
32+
interconnected dapps.
33+
34+
Additional information on how IBC works can be found [here](https://ibc.cosmos.network/). and xCall spec is
35+
defined [here](https://github.com/icon-project/IIPs/blob/master/IIPS/iip-52.md)
2036

2137
# Table of Content
2238

2339
- [IBC INTEGRATION](#ibc-integration)
2440
- [Table of Content](#table-of-content)
25-
- [About ](#about--)
26-
- [Installation ](#installation--)
27-
- [Getting Started ](#getting-started--)
28-
- [Prerequiste](#prerequiste)
29-
- [Running the tests](#testing)
41+
- [About ](#about--)
42+
- [Installation ](#installation--)
43+
- [Getting Started ](#getting-started--)
44+
- [Prerequisite](#prerequiste)
45+
- [Running the tests](#testing)
3046

3147
## About <a name = "about"> </a>
3248

3349
## Installation <a name = "installation"> </a>
34-
This project uses git submodules. Use the following command to clone this repository including the required submodules.
50+
51+
This project uses git submodules. Use the following command to clone this repository including the required submodules.
52+
3553
```sh
3654
git clone --recurse-submodules https://github.com/icon-project/IBC-Integration
3755
```
56+
3857
Or To update submodules, run the following command,
58+
3959
```
4060
git submodule init
4161
git submodule update --remote
@@ -44,7 +64,7 @@ git submodule update --remote
4464
## Getting Started <a name = "getting_started"> </a>
4565

4666
Terminologies used in this project.
47-
67+
4868
- [ibc packet](./docs/terminologies/ibc_terminologies.md)
4969
- [ibc message](./docs/terminologies/ibc_terminologies.md)
5070
- [openInit](./docs/terminologies/ibc_terminologies.md)
@@ -53,22 +73,24 @@ Terminologies used in this project.
5373
- [openConfirm](./docs/terminologies/ibc_terminologies.md)
5474

5575
### Available Integrations
76+
5677
- ICON
5778
- Archway
5879

5980
### Project Structure
60-
| Directory | Description |
61-
|:----------|:------------------------------------------------------------------------------|
62-
| [/contracts/cosmwasm-vm](./contracts/cosmwasm-vm) | Includes contracts for cosmwasm based chains |
63-
| [/contracts/evm](./contracts/evm) | Includes contracts for evm based chains |
64-
| [/contracts/javascore](./contracts/javascore) | Includes contracts for ICON chain |
65-
| [/docs](./docs) | Documentation |
66-
| [/libraries/rust](./libraries/rust) | Common rust libraries used across multiple integrations |
67-
| [/proto](./proto) | Proto files used for IBC |
68-
| [/resources](./resources) | Static resources in project. For example images, bin files, etc |
69-
| [/scripts](./scripts) | Scripts to automate task in project, for example build scripts, deploy scripts|
70-
| [/test](./test) | Test Framework and Test Suite including e2e test and functional test |
71-
| [/utils](./utils) | Utilities used for build, setup, CI/CD |
81+
82+
| Directory | Description |
83+
|:--------------------------------------------------|:-------------------------------------------------------------------------------|
84+
| [/contracts/cosmwasm-vm](./contracts/cosmwasm-vm) | Includes contracts for cosmwasm based chains |
85+
| [/contracts/evm](./contracts/evm) | Includes contracts for evm based chains |
86+
| [/contracts/javascore](./contracts/javascore) | Includes contracts for ICON chain |
87+
| [/docs](./docs) | Documentation |
88+
| [/libraries/rust](./libraries/rust) | Common rust libraries used across multiple integrations |
89+
| [/proto](./proto) | Proto files used for IBC |
90+
| [/resources](./resources) | Static resources in project. For example images, bin files, etc |
91+
| [/scripts](./scripts) | Scripts to automate task in project, for example build scripts, deploy scripts |
92+
| [/test](./test) | Test Framework and Test Suite including e2e test and functional test |
93+
| [/utils](./utils) | Utilities used for build, setup, CI/CD |
7294

7395
## Testing <a name = "testing"> </a>
7496

@@ -78,7 +100,6 @@ Terminologies used in this project.
78100
go test -v ./test/integration --args -config=<path to config.json>
79101
```
80102

81-
82103
### End-to-End Testing for the System
83104

84-
[End to End Testing Setup](./docs/e2e_test_setup.md)
105+
[End-to-End Testing Setup](./docs/e2e_test_setup.md)

0 commit comments

Comments
 (0)