feat: first draft of README rewrite #88
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alilleybrinker
force-pushed
the
rewrite_readme
branch
from
3b3e2db to
2491ad1
Compare
This commit rewrites the README to more clearly explain the background and goals of OmniBOR and of the Rust implementation. Right now it delegates info to crate-specific READMEs which haven't been written yet. So there's more work to do prior to merge. We also need to at least publish a placeholder omnibor crate to crates.io. Signed-off-by: Andrew Lilley Brinker <[email protected]>
alilleybrinker
force-pushed
the
rewrite_readme
branch
from
2491ad1 to
5303ef8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit rewrites the README to more clearly explain
the background and goals of OmniBOR and of the Rust
implementation.
Right now it delegates info to crate-specific
READMEs which haven't been written yet. So there's more
work to do prior to merge. We also
need to at least publish a placeholder omnibor crate to crates.io.