Update README title and add logo & badges #665
Conversation
Pull Request Test Coverage Report for Build 14652272719Details
💛 - Coveralls |
DanGould
left a comment
There was a problem hiding this comment.
Going to squash these two commits and merge when ready
"Rust-payjoin" changing to "Payjoin Dev Kit" in the title suggests another readme specifically for the payjoin crate may be more appropriate. To avoid that, I'd rather follow rust-bitcoin's lead here since our repo and org are payjoin and not payjoindevkit and leave it as Rust Payjoin
The discord SERVER_ID is 1120791584674435134 (in the url. try that. don't see 'widget' in settings anywhere
I'd rather leave the license off (technically MIT NFA) and put crates.io and docs.rs links instead
- 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
This reverts the title of the README as Rust-Payjoin from Payjoin Dev Kit, since the repo includes more than just the Dev Kit. It also removes the license badge and adds a crates.io and docs.rs badge
3d4a946 to
b827826
Compare
Apologies for the double commit, fixed now.
Done
Unfortunately I tried that and I'm seeing "chat widget disabled". I do think there is something that we need to enable in Discord settings for this. According to shields.io, which hosts these badges, you can enable the widget by going to "Server Settings" -> "Widget" -> "Enable Server Widget". Is that no longer there? Happy punt that one badge addition if it's too much effort for the payoff right now.
License removed, crates.io and docs.rs added, good call. |
|
haven't been able to get the discord widget setting to come up on the server :/. Maybe just drop that for now but otherwise LGTM. Thanks for the patience with review and the back and forth |
Discord badge removed, ready to go! |
DanGould
left a comment
There was a problem hiding this comment.
ACK the CI is failing because of something unrelated

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: