Skip to content

Commit ce16b46

Browse files
committed
Update readme
The site is up and running now, lets update the readme to reflect this. While we are at it mention the fact that the cookbook depends on a specific version of `rust-bitcoin` and that this may not be the latest available version. Link to both.
1 parent 79e5c70 commit ce16b46

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# Website source for `www.rust-bitcoin.org`
22

3-
While the website is deployed at rust-bitcoin.org there are still missing parts such as the cookbook.
4-
We will be happy to receive contributions adding interesting examples.
5-
63
Website for the rust-bitcoin ecosystem. The site is built using [hugo](https://gohugo.io/) and the
74
[nightfall](https://themes.gohugo.io/themes/hugo-theme-nightfall/) theme.
85

96
Includes a cookbook built with [mdbook](https://rust-lang.github.io/mdBook/).
107

8+
Contributions most welcome and appreciated. If you come here looking for how to do something and
9+
find it missing please consider contributing an example or raising an issue.
10+
11+
## Current rust-bitcoin version
12+
13+
This cookbook is currently based on [rust-bitcoin `v0.31.1`](https://docs.rs/bitcoin/0.31.1/bitcoin/index.html)
14+
1115
## License
1216

1317
This website is licensed under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc].

cookbook/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
Welcome to the `rust-bitcoin` cookbook!
66
This cookbook is designed to provide readers with a
77
comprehensive understanding of `rust-bitcoin` and its key features.
8-
Don't forget to check [`rust-bitcoin`'s documentation](https://docs.rs/bitcoin)
8+
9+
Cookbook currently depends on `rust-bitcoin` version [`v0.31.1`](https://docs.rs/bitcoin/0.31.1/bitcoin/index.html).
10+
This may not be the [latest available version](https://docs.rs/bitcoin) of `rust-bitcoin`.
911

1012
## How to contribute
1113

0 commit comments

Comments
 (0)