docs(readme): add short description at the top, reorganize readme #466
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
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.
I wasn't sure what this project really was or how it worked.
I'm still not very sure, but figured this guess, informed by a conversation with a friend who uses the project, might be better than nothing.
You're more than welcome to totally redo it, use parts of it, or make no changes.
If you'd like to take it even further, I might suggest adding whether it uses wadler's algorithm, in what cases it'll "listen" to the user's preferences vs format from the AST in whole cloth, and provide a few examples of its opinions in before/after format.