From 4c4fb550848b923bee0c47323f2eff7774dc146a Mon Sep 17 00:00:00 2001 From: masapr <40862722+masapr@users.noreply.github.com> Date: Thu, 7 Dec 2023 09:40:37 +0100 Subject: [PATCH] Update README.md (#680) * Update README.md Added introductory text on the api-client * Update intruction text --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cdc777eb4..6d879e5cc 100644 --- a/README.md +++ b/README.md @@ -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. It's particularly useful for setups with no-std environment (which are typical for trusted execution environmnets or embedded devices). It provides similar functionalities as [Polkadot-js](https://wiki.polkadot.network/docs/polkadotjs), such as easy extrinsic submission and state queries. With an RPC client, developers can easily interact with any [Polkadot](https://polkadot.network/) or [Kusama](https://kusama.network/) chain. There are several [RPC clients](https://wiki.polkadot.network/docs/build-tools-index#rpc-and-api-tools) available in different programming languages. For Rust, the most popular RPC client is [subxt](https://github.com/paritytech/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. + +The substrate-api-client connects to the substrate's RPC interface via WebSockets allowing to * Compose extrinsics, send them (asynchronously and synchronously) and subscribe to updates (synchronously). * Support `no_std` builds. Only the rpc-client is std only. For `no_std` builds, a custom rpc client needs to be implemented.