Skip to content

Remove Slack link and other updates to README #1628

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.

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
Jul 27, 2022

Conversation

tnull
Copy link
Contributor

@tnull tnull commented Jul 22, 2022

This started off as me simply wanting to remove the deprecated Slack link, but I couldn't keep myself from making at least some additional changes while touching the README.

I think it could be updated quite a bit more, but these changes are maybe a first step.

@codecov-commenter
Copy link

codecov-commenter commented Jul 22, 2022

Codecov Report

Merging #1628 (16d40ef) into main (834fe63) will decrease coverage by 0.02%.
The diff coverage is n/a.

❗ Current head 16d40ef differs from pull request most recent head cf7655a. Consider uploading reports for the commit cf7655a to get more accurate results

@@            Coverage Diff             @@
##             main    #1628      +/-   ##
==========================================
- Coverage   90.80%   90.78%   -0.03%     
==========================================
  Files          80       80              
  Lines       44654    44654              
  Branches    44654    44654              
==========================================
- Hits        40550    40539      -11     
- Misses       4104     4115      +11     
Impacted Files Coverage Δ
lightning/src/ln/functional_tests.rs 96.87% <0.00%> (-0.17%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 834fe63...cf7655a. Read the comment docs.

README.md Outdated
6. [lightning-persister](./lightning-persister)
Utilities to manage Rust-Lightning channel data persistence and retrieval.
Implements utilities to manage Rust-Lightning channel data persistence and retrieval.
Copy link
Contributor

@dunxen dunxen Jul 24, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Implements utilities to manage Rust-Lightning channel data persistence and retrieval.
Implements utilities to manage rust-lightning channel data persistence and retrieval.

Repo name should probably be lowercase for consistency too (unless start of a sentence)? Here and elsewhere there's a mix of "Rust-Lightning" and "rust-lightning"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mh, I'm not sure if there is consensus on this. I'd say if we see Rust-Lightning as a thing that is more than the main crates itself, it probably should be capitalized. However, I'd argue rust-lightning is just the Rust library and the 'more' part would be LDK and therefore agree to keep it consistently lower case. So I now replaced Rust-Lightning with rust-lightning in most places, except for headings and the tag line.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, yeah that makes sense. I guess Rust-Lightning was in its previous life :)

README.md Outdated
@@ -1,4 +1,4 @@
`rust-lightning`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for reverting this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think rust-lightning in headings and/or the tag line looks odd and decided to revert to title case for these, i.e., Rust-Lightning. Happy to always use rust-lightning if there is a clear preference for that though.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer keeping it consistent, no big deal though.

Copy link
Contributor

@wpaulino wpaulino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TheBlueMatt
Copy link
Collaborator

I think feel free to squash.

@tnull tnull force-pushed the 2022-07-readme-remove-slack branch from cde288f to cf7655a Compare July 27, 2022 07:01
@tnull
Copy link
Contributor Author

tnull commented Jul 27, 2022

Squashed

@TheBlueMatt TheBlueMatt merged commit 4905df8 into lightningdevkit:main Jul 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants