Skip to content

Commit 518d8d2

Browse files
authored
Update README title and add logo & badges (payjoin#665)
Update the README header to add a little more pizzaz. Specifically: - Changes "Rust-Payjoin" title to "Payjoin Dev Kit" since that is the colloquial term we use - Adds "static" directory for images and places the Payjoin "monad" logo in it - Adds badges for: License, code coverage, Discord chat, MSRV, and CI There are still a couple pieces of information I need to complete this: - The Discord needs to be updated to [enable](https://discord.com/blog/add-the-discord-widget-to-your-site) the [shields.io](https://shields.io/badges/discord) widget. - I believe coveralls is already setup and working for payjoin as it's displaying 82% coverage when attached to the payjoin repo, but this needs to be verified. ![image](https://github.com/user-attachments/assets/c00a125d-00cf-4fcf-b2f7-c6984b4483aa)
2 parents 3b23dca + cbcfd0e commit 518d8d2

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
1-
# Rust-Payjoin
1+
<div align="center">
2+
<h1>Rust-Payjoin</h1>
23

3-
Supercharged payment batching to save you fees and preserve your privacy.
4+
<img src="./static/monad.svg" width="150" />
5+
6+
<p>
7+
<strong>Supercharged payment batching to save fees and preserve privacy</strong>
8+
</p>
9+
10+
<p>
11+
<a href="https://crates.io/crates/payjoin"><img alt="Crates" src="https://img.shields.io/crates/v/payjoin.svg?logo=rust"></a>
12+
<a href="https://docs.rs/payjoin"><img alt="Crates" src="https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=payjoin&color=f75390"></a>
13+
<a href="https://github.com/payjoin/rust-payjoin/actions/workflows/rust.yml"><img alt="CI Status" src="https://github.com/payjoin/rust-payjoin/actions/workflows/rust.yml/badge.svg"></a>
14+
<a href="https://coveralls.io/github/payjoin/rust-payjoin?branch=master"><img src="https://coveralls.io/repos/github/payjoin/rust-payjoin/badge.svg?branch=master"/></a>
15+
<a href="https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html"><img alt="Rustc Version 1.63.0+" src="https://img.shields.io/badge/rustc-1.63.0%2B-lightgrey.svg"/></a>
16+
</p>
17+
18+
<h4>
19+
<a href="https://payjoindevkit.org">Project Homepage</a>
20+
</h4>
21+
</div>
422

523
## About
624

@@ -24,7 +42,7 @@ The [`payjoin-test-utils`](https://github.com/payjoin/rust-payjoin/tree/master/p
2442

2543
**Use at your own risk. This crate has not yet been reviewed by independent Rust and Bitcoin security professionals.**
2644

27-
While I don't think there is a *huge* risk running it, be careful relying on its security for now!
45+
While I don't think there is a _huge_ risk running it, be careful relying on its security for now!
2846

2947
Seeking review of the code that verifies there is no overpayment. Contributions are welcome!
3048

static/monad.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)