Skip to content

Docs: Updated README to include crates information #1248

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

Conversation

naveensrinivasan
Copy link
Contributor

Included crates information into README.

README.md Outdated
Crates
-----------
1. [lightning](./lightning)
1. [lightning-background-processor](./lightning-background-processor)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe change the numbers :). But, should we say a brief word about each? Should be able to copy and tweak the information in each directory's Cargo.toml.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can change the numbers. I was also thinking about adding some description but didn't know where to look for it.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Look at the Cargo.toml and the crate's documentation (ie the big //! comment at the top of lib.rs).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used the Cargo.toml docs. Let me know.

@codecov-commenter
Copy link

codecov-commenter commented Jan 18, 2022

Codecov Report

Merging #1248 (25fd84d) into main (34cdca9) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 25fd84d differs from pull request most recent head 1d20f2b. Consider uploading reports for the commit 1d20f2b to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1248      +/-   ##
==========================================
- Coverage   90.42%   90.41%   -0.02%     
==========================================
  Files          70       70              
  Lines       38087    38087              
==========================================
- Hits        34441    34436       -5     
- Misses       3646     3651       +5     
Impacted Files Coverage Δ
lightning/src/ln/functional_tests.rs 97.28% <0.00%> (-0.09%) ⬇️

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 34cdca9...1d20f2b. 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.

LGTM, can you squash the commits here?

Included crates information into README.
@naveensrinivasan naveensrinivasan force-pushed the naveen/feat/update-readme branch from 1d20f2b to f29e485 Compare January 19, 2022 19:27
@naveensrinivasan
Copy link
Contributor Author

LGTM, can you squash the commits here?

Done. Thanks!

@TheBlueMatt TheBlueMatt merged commit 581a800 into lightningdevkit:main Jan 20, 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.

4 participants