Skip to content

Commit 3d3993a

Browse files
committed
Add Rust-Bitcoin logo and project header.
Remove old shields. Replace with new single gear logo. Add license, readme, and source files under /logo.
1 parent ebf9162 commit 3d3993a

6 files changed

+296
-6
lines changed

README.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
1-
![Continuous integration](https://github.com/rust-bitcoin/rust-bitcoin/workflows/Continuous%20integration/badge.svg)
2-
[![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
1+
<div align="center">
2+
<h1>Rust Bitcoin</h1>
33

4-
# Rust Bitcoin Library
4+
<img alt="Rust Bitcoin logo by Hunter Trujillo, see license and source files under /logo" src="./logo/rust-bitcoin.png" width="300" />
5+
6+
<p>Library with support for de/serialization, parsing and executing on data-structures
7+
and network messages related to Bitcoin.
8+
</p>
9+
10+
<p>
11+
<a href="https://crates.io/crates/bitcoin"><img alt="Crate Info" src="https://img.shields.io/crates/v/bitcoin.svg"/></a>
12+
<a href="https://github.com/rust-bitcoin/rust-bitcoin/blob/master/LICENSE"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
13+
<a href="https://github.com/rust-bitcoin/rust-bitcoin/actions?query=workflow%3AContinuous%20integration"><img alt="CI Status" src="https://github.com/rust-bitcoin/rust-bitcoin/workflows/Continuous%20integration/badge.svg"></a>
14+
<a href="https://docs.rs/bitcoin"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-bitcoin-green"/></a>
15+
<a href="https://blog.rust-lang.org/2018/09/13/Rust-1.29.html"><img alt="Rustc Version 1.29+" src="https://img.shields.io/badge/rustc-1.29%2B-lightgrey.svg"/></a>
16+
<a href="https://gnusha.org/bitcoin-rust/"><img alt="Chat on IRC" src="https://img.shields.io/badge/irc-%23bitcoin--rust%20on%20libera.chat-blue"></a>
17+
<img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/rust-bitcoin/rust-bitcoin">
18+
</p>
19+
</div>
520

6-
Library with support for de/serialization, parsing and executing on data
7-
structures and network messages related to Bitcoin.
821

922
[Documentation](https://docs.rs/bitcoin/)
1023

@@ -104,7 +117,7 @@ You can run tests with:
104117
cargo test
105118
```
106119

107-
Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions.
120+
Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions.
108121

109122
## Pull Requests
110123

logo/README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Rust Bitcoin Logo
2+
3+
## Files
4+
5+
Included are:
6+
7+
- [rust-bitcoin-inkscape.svg](./rust-bitcoin-inkscape.svg) - The Inkscape source file with the things used to make the logo in case adjustments are desired
8+
- [rust-bitcoin-optimized.svg](./rust-bitcoin-optimized.svg) - An optimized SVG for embedding or rendering at any size desired
9+
- [rust-bitcoin.png](./rust-bitcoin.png) - The PNG logo rendered at 300px used by this project
10+
- [rust-bitcoin-large.png](./rust-bitcoin-large.png) - A larger size 1024px x 1024px for convenience for embedding in presentations
11+
12+
## Author
13+
14+
Hunter Trujillo, @cryptoquick on [Twitter](https://twitter.com/cryptoquick), [GitHub](https://github.com/cryptoquick), and Telegram.
15+
16+
## License
17+
18+
Licensed in the public domain under [CC0 1.0 Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/), and the author of this work rescinds all claims to copyright or coercion or acts of force from any nation state over this work for any purpose
19+
20+
Bitcoin Logo is licensed under the CC Public Domain Dedication: <https://bitcoin.stackexchange.com/a/53422> and <https://bitcointalk.org/index.php?topic=1631.0>
21+
22+
Rust Logo is licensed under CC-BY, which allows reuse and modifications for any purpose, as long as distributors give appropriate credit and indicate changes have been made. See here: <https://www.rust-lang.org/policies/media-guide>
23+
24+
## Acknowledgements
25+
26+
Acknowledgement for the runners up in this PR: https://github.com/rust-bitcoin/rust-bitcoin/pull/891#issuecomment-1074476858
27+
28+
In particular, the Rust Bitcoin Wizard gear was an incredibly inspired piece of art. Also, the meshed gears design was beloved by some but not all.
29+
30+
Thank you to the Rust Bitcoin maintainers and community, your timely responses and guidance was appreciated.
31+
32+
Also, thank you to the voters on the Rust in Bitcoin Telegram group: <https://t.me/rust_in_bitcoin/321>.

0 commit comments

Comments
 (0)