Skip to content

Commit

Permalink
Update docs (#2894)
Browse files Browse the repository at this point in the history
* Update README.md

* Update coinswap.md

* Update intro.md

* Update service.md
  • Loading branch information
efushigi authored Dec 12, 2023
1 parent 83ccaec commit 9c460e8
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
3 changes: 1 addition & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,5 @@

## About IRISnet

IRISnet (a.k.a IRIS Hub) is designed to be the foundation for the next generation distributed applications. Built with Cosmos-SDK, IRIS Hub enables cross-chain interoperability through a unified service model, while providing a variety of modules to support DeFi applications.
IRISnet (a.k.a IRIS Hub) is designed to be the foundation for the next generation distributed applications. Built with Cosmos-SDK, IRIS Hub enables cross-chain interoperability through a unified service model, while providing a variety of modules to support distributed business applications.

IRISnet dev teams include Bianjie, a national award-winning blockchain technology team based in Shanghai, and [Tendermint](https://tendermint.com), the world-famous team that created the Tendermint consensus engine and the Cosmos project.
4 changes: 2 additions & 2 deletions docs/cli-client/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ All GET commands has the following global flags:
| Name, shorthand | type | Required | Default Value | Description |
| --------------- | ------ | -------- | -------------------- | ------------------------------------ |
| --chain-id | string | | | Chain ID of tendermint node |
| --home | string | | /Users/bianjie/.iris | Directory for config and data |
| --home | string | | ~/.iris | Directory for config and data |
| --trace | string | | | Print out full stack trace on errors |

### POST Commands
Expand Down Expand Up @@ -52,7 +52,7 @@ All POST commands have the following global flags:
| --trust-node | bool | | true | Don't verify proofs for responses |
| --yes | bool | | true | Skip tx broadcasting prompt confirmation |
| --chain-id | string | | | Chain ID of tendermint node |
| --home | string | | | Directory for config and data (default "/Users/bianjie/.iris") |
| --home | string | | | Directory for config and data (default "~/.iris") |
| --trace | string | | | Print out full stack trace on errors |

## Module Commands
Expand Down
2 changes: 1 addition & 1 deletion docs/cli-client/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Service module allows you to define, bind, invoke services on the IRIS Hub. [Read more about iService](../features/service.md).

## 可用命令
## Available Commands

| Name | Description |
| ------------------------------------------------------- | ------------------------------------------------------------------ |
Expand Down
4 changes: 2 additions & 2 deletions docs/features/coinswap.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Coinswap Token Exchange
# Coinswap

## Summary

Expand Down Expand Up @@ -64,4 +64,4 @@ Use a constant product as the market making formula: `x * y = k`, `x` represent

## Additional information

This module does not provide a command entry but the relevant REST interfaces, through which you can initiate the above transactions. Here we provide a **Demo** [Coinswap](https://github.com/zhiqiang-bianjie/coinswap) front-end interface. See instructions for the specific usage.
This module does not provide a command entry but the relevant REST interfaces, through which you can initiate the above transactions.

0 comments on commit 9c460e8

Please sign in to comment.