Skip to content

Commit f0ef70c

Browse files
committed
feat(doc): add license section to README and update badges
1 parent c75c2d6 commit f0ef70c

1 file changed

Lines changed: 24 additions & 8 deletions

File tree

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
1-
# rust-electrum-client
2-
[![Build Status]][GitHub Workflow] [![Latest Version]][crates.io] [![MSRV Badge]][Rust Blog]
1+
# rust-electrum-client
32

4-
[Build Status]: https://github.com/bitcoindevkit/rust-electrum-client/actions/workflows/cont_integration.yml/badge.svg
5-
[GitHub Workflow]: https://github.com/bitcoindevkit/rust-electrum-client/actions?query=workflow%3ACI
6-
[Latest Version]: https://img.shields.io/crates/v/electrum-client.svg
7-
[crates.io]: https://crates.io/crates/electrum-client
8-
[MSRV Badge]: https://img.shields.io/badge/rustc-1.75.0%2B-lightgrey.svg
9-
[Rust Blog]: https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html
3+
<p>
4+
<a href="https://crates.io/crates/electrum-client"><img src="https://img.shields.io/crates/v/electrum-client.svg"/></a>
5+
<a href="https://docs.rs/electrum-clien"><img src="https://img.shields.io/badge/docs.rs-electrum--client-blue"/></a>
6+
<a href="https://https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html"><img src="https://img.shields.io/badge/MSRV-1.75.0%2B-orange.svg"/></a>
7+
<a href="https://github.com/bitcoindevkit/rust-electrum-client/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT%2FApache--2.0-red.svg"/></a>
8+
<a href="https://github.com/bitcoindevkit/rust-electrum-client/actions/workflows/cont_integration.yml"><img src="https://github.com/bitcoindevkit/rust-electrum-client/actions/workflows/cont_integration.yml/badge.svg"></a>
9+
</p>
1010

1111
Bitcoin Electrum client library. Supports plaintext, TLS and Onion servers.
1212

1313
## Minimum Supported Rust Version (MSRV)
1414

1515
This library should compile with any combination of features with Rust 1.75.0.
16+
17+
## License
18+
19+
Licensed under either of
20+
21+
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
22+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
23+
24+
at your option.
25+
26+
### Contribution
27+
28+
Unless you explicitly state otherwise, any contribution intentionally
29+
submitted for inclusion in the work by you, as defined in the Apache-2.0
30+
license, shall be dual licensed as above, without any additional terms or
31+
conditions.

0 commit comments

Comments
 (0)