Improve readme #29
Merged
Improve readme #29
Conversation
This file contains hidden or 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
I found this wall of text a little difficult to parse. I think it works much better with some headings. While I was at it, I decided to wrap some long lines to be more consistent with the rest of this document.
The alphabetical sorting is easy to understand, making it easier for people to find scripts that they are looking for and making it easier for future devs to know where to add new scripts.
This mentions "These three scripts" when there are four mentioned, and I am unable to find any references to `--no-explicit-require` in code, so I think this sentence is outdated and should be removed. Digging through history, it seems like this was brought over from 1c672cb when code was imported from the React repo.
This useful transform was undocumented, so I decided to copy the comment from the top of the file into the readme. This will help make it more discoverable.
This transform exists, but was not mentioned in the readme. I haven't taken the time to look at it and understand what it does, so I didn't write a description, but I figure that something is better than nothing.
This will give us a little bit of syntax highlighting and cut down on the number of bullet points on the page. My goal here is to make this document easier to read.
| Swweeet! |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Adjusted formatting, removed old copy, sorted things, and added missing transforms.