|
1 | | -# Rust Bitcoin |
| 1 | +# Introduction |
2 | 2 |
|
3 | | -[`rust-bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) is a library for working with Bitcoin in Rust. |
4 | | -It contains Bitcoin network protocol and associated primitives. |
5 | | -You can find more by reading the [documentation](https://docs.rs/bitcoin). |
| 3 | +This book is created and maintained by those involved in the |
| 4 | +[`rust-bitcoin`](https://github.com/rust-bitcoin) GitHub organization, contributions are |
| 5 | +appreciated. It covers various crates from the org and as such, aims to be useful to developers |
| 6 | +wanting to write code in Rust that interacts with the Bitcoin network. It is specifically not |
| 7 | +limited to just the [`rust-bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) crate, although |
| 8 | +that is a good starting point if you want a one-stop-shop for interacting with Bitcoin in Rust. |
6 | 9 |
|
7 | | -This cookbook provides straightforward examples that showcase effective approaches |
8 | | -for accomplishing typical Bitcoin-related programming tasks, |
9 | | -and utilizing the Rust ecosystem's crates. |
| 10 | +There are a number of good libraries outside of the `rust-bitcoin` organization that use the crates |
| 11 | +covered here, two that you might like to check out are: |
10 | 12 |
|
11 | | -The book covers various topics, including receiving data over P2P, |
12 | | -parsing blocks and transactions, |
13 | | -and constructing and signing transactions. |
| 13 | +- [`Bitcoin Dev Kit`](https://bitcoindevkit.org/) |
| 14 | +- [`Lightning Dev Kit`](https://lightningdevkit.org/) |
14 | 15 |
|
15 | | -## Table of Contents |
| 16 | +Finally, this book is currently a work inn progress but hopes to eventually cover various topics, |
| 17 | +including parsing blocks and transactions, constructing and signing transactions, receiving data |
| 18 | +over the peer-to-peer network, plus fun stuff you can do with miniscript. |
16 | 19 |
|
17 | | -This book contains: |
| 20 | +## Table of Contents |
18 | 21 |
|
19 | 22 | 1. [Getting Started](getting_started.md) |
20 | 23 | 1. [Constructing and Signing Transactions](tx.md) |
|
0 commit comments