Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #680

Merged
merged 3 commits into from
Dec 7, 2023
Merged

Update README.md #680

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1195f2
Update README.md
masapr Nov 28, 2023
ffc0e33
Merge remote-tracking branch 'origin/master' into update-readme/sp
masapr Dec 5, 2023
0e84b45
Update intruction text
masapr Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slightly changed wording - what do you think?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added most of it. I still want to comment on "no-std" right at the beginning, so I added a sentence on that.


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.
Expand Down
Loading