Update README.md #680
Update README.md #680
Conversation
Added introductory text on the api-client
masapr
added
F4-documentation
README.md
Outdated
| @@ -1,6 +1,8 @@ | |||
| # substrate-api-client | |||
|
|
|||
| substrate-api-client is a library written in Rust for connecting to the substrate's RPC interface via WebSockets allowing to | |||
| The substrate-api-client is a Rust library for connecting to a [substrate](https://substrate.io/)-based node via RPC from a no-std environment. An RPC client is a library, with similar features as [Polkadot-js](https://wiki.polkadot.network/docs/polkadotjs). With an RPC client developers can easily interact with any [Polkadot](https://polkadot.network/) or [Kusama](https://kusama.network/) chain. There are [RPC clients](https://wiki.polkadot.network/docs/build-tools-index#rpc-and-api-tools) for different programming languages. For Rust, the most popular RPC client is [subxt](https://github.com/paritytech/subxt). The substrate-api-client uses core functionality of subxt and makes it available in a no-std environment. | |||
There was a problem hiding this comment.
The substrate-api-client is a Rust library for connecting to a substrate-based node via RPC. It provides similar functionalities as Polkadot-js, such as easy extrinsic submission and state queries. With an RPC client, developers can easily interact with any Polkadot or Kusama chain. There are several RPC clients available in different programming languages. For Rust, the most popular RPC client is subxt. The substrate-api-client provides a simpler, less extensive alternative to subxt, focused on providing as many features as possible for no-std environments.
There was a problem hiding this comment.
Slightly changed wording - what do you think?
There was a problem hiding this comment.
I added most of it. I still want to comment on "no-std" right at the beginning, so I added a sentence on that.
Added introductory text on the api-client