Closed garricn closed 1 month ago
garricn
commented
2 months ago Hey @SimplyDanny, I realize this is a large diff but @tinder-cfuller and I were inspired to give the README some love after contributing the plugin work. We felt that the plugin info improvements would be helpful for the community when adopting the plugins. Once we got started, we decided to look at the Installation and Setup info more holistically. We hope you like how it turned out. Thank you.
tinder-cfuller
commented
2 months ago Hi @SimplyDanny What are your thoughts about getting this PR merged in before the next SwiftLint release? Please advise. Thank you! 🙏
SwiftLintBot
commented
1 month ago | 1 Warning | |
|---|---|
| :warning: | Big PR |
Generated by :no_entry_sign: Danger
tinder-cfuller
commented
1 month ago Hi @SimplyDanny How is this looking to you now? Do you have any additional revisions before this may be merged in? Please advise. Thank you!
SimplyDanny
commented
1 month ago Feels very structured and easily readable. Thank you both for all the fixes and further improvements!
As a follow up to the recent PRs improving the build tool plugin and adding the command plugin, this PR incorporates several improvements to the README throughout. For example, some out dated information has been removed, sections have been reordered to improve organization, the video introduction was moved towards the top and some screenshots have been replaced with code to enable copy and paste. Information within Installation and Setup was de-mixed and moved to their appropriate sections. Headings and formatting have been tidied up throughout the document. Lastly, consistent line wrapping to 80 columns was applied to match the bulk of the existing text.