Refactor README and Implementation #16
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
Closed
dabrahams
reviewed
Mar 6, 2021
dabrahams
reviewed
Mar 6, 2021
dabrahams
approved these changes
Mar 6, 2021
|
No problem.. how would you like to be credited? Should I find somewhere to work it into the text or create a separate authors/contributors.md file? |
|
Thanks; I'm happy to leave the details completely in your hands. |
|
Okay, I added a credits section to the README.. seemed like the easiest way to give credit to everyone else who's contributed since it's not a verylong list. |
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 refactors the README to be user-facing documentation rather than diving straight into the implementation, based on #15.
I also edited the
Implementation.md(former README) for flow, since parts became hard to read when the implementation changed from using (rendered) markdown#headers to going into the (not visible while rendered) code block header after #3.