diff --git a/README.md b/README.md index c331d1de90..a5dc6461b3 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,5 @@ -# 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) +# subxt + +## Placeholder awaiting release: renamed from https://crates.io/crates/substrate-subxt A library to **sub**mit e**xt**rinsics to a [substrate](https://github.com/paritytech/substrate) node via RPC. - -### :warning: Health Warning :warning: considered *alpha* after recent changes, API still subject to change - -#### See https://github.com/paritytech/subxt/issues/309 for an overview of outstanding issues. - -## Usage - -See [examples](./examples). - -## Integration Testing - -Most tests require a running substrate node to communicate with. This is done by spawning an instance of the -substrate node per test. It requires an executable binary `substrate` at [`polkadot-v0.9.10`](https://github.com/paritytech/substrate/releases/tag/polkadot-v0.9.10) on your path. - -This can be installed from source via cargo: - -```bash -cargo install --git https://github.com/paritytech/substrate node-cli --tag=polkadot-v0.9.10 --force -``` - -**Alternatives** - -[substrate-api-client](https://github.com/scs/substrate-api-client) provides similar functionality. - -## Subxt Client -By default the client builder will connect to a full node via rpc. The `subxt-client` helps -embedding a light client directly. It can also be used to embed a full node. This is especially -useful for testing and ci. - -#### License - - -The entire code within this repository is licensed under the GPLv3. -Please contact us if you have questions about the licensing of our - products. -