Updating README #97
Merged
Updating README #97
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
Signed-off-by: Tom Meadows <[email protected]>
jkjell
previously approved these changes
Dec 11, 2023
jkjell
requested changes
Dec 11, 2023
jkjell
approved these changes
Dec 11, 2023
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.
Since this separate library has existed, the README has been a copy of the main repository README.
While there is a lot of work to do on refactoring documentation, I think simplifying this README is a nice start. This makes it easier to understand what the repository serves as, and also removes the current problems observed with references to documentation in this README.
At a certain point we will aim to consolidate all witness related documentation into a single docs source location and expose that with a public frontend.