Skip to content

Commit

Permalink
Merge pull request #18 from icon-project/docs/update-readme-with-rele…
Browse files Browse the repository at this point in the history
…vant-links

feat: Update readme to include important links and topics
  • Loading branch information
ibrizsabin authored Aug 10, 2023
2 parents 0c57444 + 6a15678 commit 6b332f8
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
[rust-cov-badge]: https://codecov.io/gh/icon-project/xCall/branch/main/graph/badge.svg?token=KWDB59JITE&flag=rust

# XCall
XCall is a cross chain messaging service built to mimic regular transaction flows across any interoperable solution.

For full xCall specification see [XCall Spec](./docs/adr/xcall.md).

## Building with xCall
For building dapps with xCall see official developer [docs](https://www.xcall.dev/).

### Project Structure
| Directory | Description |
Expand All @@ -18,4 +24,17 @@
| [/contracts/evm](./contracts/evm) | Includes contracts for evm based chains |
| [/contracts/javascore](./contracts/javascore) | Includes contracts for ICON chain |
| [/docs](./docs) | Documentation |
| [/scripts](./scripts) | Scripts to automate task in project, for example build scripts, deploy scripts. |
| [/scripts](./scripts) | Scripts to automate task in project, for example build scripts, deploy scripts. |


## Available Connection implementations
* [IBC](https://github.com/icon-project/IBC-Integration/blob/main/docs/adr/XCall_IBC_Connection.md)
* [Rust](https://github.com/icon-project/IBC-Integration/tree/main/contracts/cosmwasm-vm/cw-xcall-ibc-connection)
* [Java](https://github.com/icon-project/IBC-Integration/tree/main/contracts/javascore/xcall-connection)
* [BTP](https://github.com/icon-project/btp2) is supported natively and does not need a connection contract.

## Building a xCall connection
If xCall is deployed, anyone can create a new connection contract to relay messages between xCall contracts.
To do this a connection contract has to be developed and deployed on both sides.

The base design for a connection can be found in the [xCall docs](./docs/adr/xcall.md#Connections)

0 comments on commit 6b332f8

Please sign in to comment.