docs: Reworked README #235
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
|
Would it be possible to scale this back to not have html elements in the markdown? We tend to try to avoid that for several reasons including easier cli output, and accessibility concerns (we'd prefer our md parser to add all html) |
|
The used html is within the GitHub Markdown flavor, but sure I can remove it. |
wraithgar
approved these changes
Dec 4, 2023
wraithgar
pushed a commit
that referenced
this pull request
Dec 4, 2023
Reworked README content / documentation to use current code standards ( read / modify / write example ), work better in npms page bounds ( 730 pixel width limit ) and be generally more easily comprehensible.
Merged
wraithgar
pushed a commit
that referenced
this pull request
Mar 4, 2024
🤖 I have created a release *beep* *boop* --- ## [4.1.2](v4.1.1...v4.1.2) (2024-03-04) ### Bug Fixes * [`e237377`](e237377) [#243](#243) Removed the unused doUnesc param in the unsafe function (#243) (@LoicE5) ### Documentation * [`31b3209`](31b3209) [#239](#239) Fix typo in `bracketedArray` option name in README.md (#239) (@futpib) * [`24eb9a0`](24eb9a0) Reworked README (#235) (@PhoneDroid) * [`fc6ce28`](fc6ce28) [#212](#212) Fix typo in `bracketedArray` option name in README.md (#212) (@futpib) ### Chores * [`29caa7c`](29caa7c) [#240](#240) postinstall for dependabot template-oss PR (@lukekarrys) * [`eafd8f7`](eafd8f7) [#240](#240) bump @npmcli/template-oss from 4.21.1 to 4.21.3 (@dependabot[bot]) * [`5cb0c9f`](5cb0c9f) [#238](#238) postinstall for dependabot template-oss PR (@lukekarrys) * [`4ad194e`](4ad194e) [#238](#238) bump @npmcli/template-oss from 4.21.0 to 4.21.1 (@dependabot[bot]) * [`a138d1f`](a138d1f) [#233](#233) postinstall for dependabot template-oss PR (@lukekarrys) * [`e37a22e`](e37a22e) [#233](#233) bump @npmcli/template-oss from 4.19.0 to 4.21.0 (@dependabot[bot]) * [`2f57997`](2f57997) [#215](#215) postinstall for dependabot template-oss PR (@lukekarrys) * [`526d5fe`](526d5fe) [#215](#215) bump @npmcli/template-oss from 4.18.1 to 4.19.0 (@dependabot[bot]) * [`98de8c2`](98de8c2) [#214](#214) postinstall for dependabot template-oss PR (@lukekarrys) * [`fd33f54`](fd33f54) [#214](#214) bump @npmcli/template-oss from 4.18.0 to 4.18.1 (@dependabot[bot]) * [`21abe16`](21abe16) [#211](#211) postinstall for dependabot template-oss PR (@lukekarrys) * [`f52bed5`](f52bed5) [#211](#211) bump @npmcli/template-oss from 4.17.0 to 4.18.0 (@dependabot[bot]) * [`da3b717`](da3b717) [#210](#210) postinstall for dependabot template-oss PR (@lukekarrys) * [`9e9adf4`](9e9adf4) [#210](#210) bump @npmcli/template-oss from 4.15.1 to 4.17.0 (@dependabot[bot]) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
Reworked README content / documentation to use current code
standards ( read / modify / write example ), work better in npms
page bounds ( 730 pixel width limit ) and be generally more easily
comprehensible.