From 31c4328c8a076f3dbef12253659ca14900437dcb Mon Sep 17 00:00:00 2001 From: James Wilson Date: Thu, 16 May 2024 12:21:39 +0100 Subject: [PATCH] Update README.md (#1584) * Update README.md Make it clear that Subxt is not just for submitting extrinsics at the top of the README * And WebAssembly --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 35dbacfe5e..dd75354ad3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # subxt · ![build](https://github.com/paritytech/subxt/workflows/Rust/badge.svg) [![Latest Version](https://img.shields.io/crates/v/subxt.svg)](https://crates.io/crates/subxt) [![Documentation](https://docs.rs/subxt/badge.svg)](https://docs.rs/subxt) -A library to **sub**mit e**xt**rinsics to a [substrate](https://github.com/paritytech/substrate) node via RPC. +Subxt is a library for interacting with [Substrate](https://github.com/paritytech/polkadot-sdk) based nodes in Rust and WebAssembly. It can: + +- Submit Extrinsics (this is where the name comes from). +- Subscribe to blocks, reading the extrinsics and associated events from them. +- Read and iterate over storage values. +- Read constants and custom values from the metadata. +- Call runtime APIs, returning the results. +- Do all of the above via a safe, statically types interface or via a dynamic one when you need the flexibility. +- Compile to WASM and run entirely in the browser. +- Do a bunch of things in a `#[no_std]` environment via the `subxt-core` crate. +- Use a built-in light client (`smoldot`) to interact with chains. ## Usage