Skip to content

Update readme #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 2, 2024
Merged

Update readme #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# Website source for `www.rust-bitcoin.org`

While the website is deployed at rust-bitcoin.org there are still missing parts such as the cookbook.
We will be happy to receive contributions adding interesting examples.

Website for the rust-bitcoin ecosystem. The site is built using [hugo](https://gohugo.io/) and the
[nightfall](https://themes.gohugo.io/themes/hugo-theme-nightfall/) theme.

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

Contributions most welcome and appreciated. If you come here looking for how to do something and
find it missing please consider contributing an example or raising an issue.

## Current rust-bitcoin version

This cookbook is currently based on [rust-bitcoin `v0.31.1`](https://docs.rs/bitcoin/0.31.1/bitcoin/index.html)

## License

This website is licensed under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication][cc].
Expand Down
4 changes: 3 additions & 1 deletion cookbook/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
Welcome to the `rust-bitcoin` cookbook!
This cookbook is designed to provide readers with a
comprehensive understanding of `rust-bitcoin` and its key features.
Don't forget to check [`rust-bitcoin`'s documentation](https://docs.rs/bitcoin)

Cookbook currently depends on `rust-bitcoin` version [`v0.31.1`](https://docs.rs/bitcoin/0.31.1/bitcoin/index.html).
This may not be the [latest available version](https://docs.rs/bitcoin) of `rust-bitcoin`.

## How to contribute

Expand Down