Skip to content

Commit bcdce9f

Browse files
committed
Merge #4: Improve introduction
85fb904 Attempt to improve the introduction (Tobin C. Harding) 487ac0f Add a getting_started page (Tobin C. Harding) 93efdca Remove the license badge from the top of the intro page (Tobin C. Harding) Pull request description: Attempt to improve the introduction page. ACKs for top commit: realeinherjar: ACK 85fb904 Tree-SHA512: 4ac95d77b3985063475e92e2c5397e1478d02e09fcf5e32210197c9210909b35167d16a8360ea159f9c99283a739dc0f991db114159602553125ff01be91cc0a
2 parents 43a9c17 + 85fb904 commit bcdce9f

3 files changed

Lines changed: 29 additions & 26 deletions

File tree

cookbook/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[Introduction](./intro.md)
44

5+
- [Getting started](getting_started.md)
56
- [Constructing and Signing Transactions](tx.md)
67
- [SegWit V0](tx_segwit-v0.md)
78
- [Taproot](tx_taproot.md)

cookbook/src/getting_started.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Getting Started
2+
3+
To add `rust-bitcoin` to your project, run:
4+
5+
```bash
6+
cargo add bitcoin
7+
```
8+
9+
If you are just exploring you probably want to use the "rand-std" feature so you can generate random keys:
10+
11+
```bash
12+
cargo add bitcoin --features=rand-std
13+
```

cookbook/src/intro.md

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,25 @@
1-
# Rust Bitcoin
1+
# Introduction
22

3-
[![CC0 1.0][cc-shield]][cc]
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.
49

5-
[`rust-bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) is a library for working with Bitcoin in Rust.
6-
It contains Bitcoin network protocol and associated primitives.
7-
You can find more by reading the [documentation](https://docs.rs/bitcoin).
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:
812

9-
To add `rust-bitcoin` to your project, run:
13+
- [`Bitcoin Dev Kit`](https://bitcoindevkit.org/)
14+
- [`Lightning Dev Kit`](https://lightningdevkit.org/)
1015

11-
```bash
12-
cargo add bitcoin
13-
```
14-
15-
Additionally, you can add flags to enable features.
16-
Here's an example:
17-
18-
```bash
19-
cargo add bitcoin --features=rand-std
20-
```
21-
22-
This cookbook provides straightforward examples that showcase effective approaches
23-
for accomplishing typical Bitcoin-related programming tasks,
24-
and utilizing the Rust ecosystem's crates.
25-
26-
The book covers various topics, including receiving data over P2P,
27-
parsing blocks and transactions,
28-
and constructing and signing transactions.
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.
2919

3020
## Table of Contents
3121

32-
This book contains:
33-
22+
1. [Getting Started](getting_started.md)
3423
1. [Constructing and Signing Transactions](tx.md)
3524
1. [SegWit V0](tx_segwit-v0.md)
3625
1. [Taproot](tx_taproot.md)

0 commit comments

Comments
 (0)