-
Notifications
You must be signed in to change notification settings - Fork 407
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
Docs: Updated README to include crates information #1248
Conversation
README.md
Outdated
Crates | ||
----------- | ||
1. [lightning](./lightning) | ||
1. [lightning-background-processor](./lightning-background-processor) |
There was a problem hiding this comment.
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
.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
).
There was a problem hiding this comment.
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 Report
@@ 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
Continue to review full report at Codecov.
|
There was a problem hiding this 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.
1d20f2b
to
f29e485
Compare
Done. Thanks! |
Included crates information into README.