Skip to content

Add content to readme #729

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 4 commits into from
Oct 2, 2020
Merged

Add content to readme #729

merged 4 commits into from
Oct 2, 2020

Conversation

casey
Copy link
Contributor

@casey casey commented Oct 2, 2020

  • Change header to "Rust-Lightning"
  • Add crate and documentation badges
  • Add introductory paragraph
  • Move previous intro content under "Status" heading

I wasn't sure where to put the old joke, but please feel free to push it to this PR branch.

Closes #728

- Change header to "Rust-Lightning"
- Add crate and documentation badges
- Add introductory paragraph
- Move previous intro content under "Status" heading
@codecov
Copy link

codecov bot commented Oct 2, 2020

Codecov Report

Merging #729 into main will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #729      +/-   ##
==========================================
+ Coverage   92.00%   92.01%   +0.01%     
==========================================
  Files          37       37              
  Lines       20106    20106              
==========================================
+ Hits        18498    18501       +3     
+ Misses       1608     1605       -3     
Impacted Files Coverage Δ
lightning/src/ln/functional_tests.rs 97.12% <0.00%> (+0.05%) ⬆️

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 8fb4a3d...1c118ed. Read the comment docs.

Copy link
Collaborator

@TheBlueMatt TheBlueMatt left a comment

Choose a reason for hiding this comment

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

Looks good sans one note.

README.md Outdated
it is runtime-agnostic, but users must implement basic networking logic, chain
interactions, and disk storage.

The `lightning-net-tokio` crate is a full Lightning using the
Copy link
Collaborator

Choose a reason for hiding this comment

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

We currently only implement the network-connection stuff. #681 does disk I/O (in a separate crate), and hopefully future ones will do chain sync.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

@TheBlueMatt TheBlueMatt merged commit e48f8e3 into lightningdevkit:main Oct 2, 2020
@casey casey deleted the readme branch October 2, 2020 22:56
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.

Consider changing about and readme text
3 participants