-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update readme with emoji #1207
Update readme with emoji #1207
Conversation
Demo of this change: https://github.com/styfle/marked/blob/readme-emoji/README.md Should I update the homepage too? https://marked.js.org/#/README.md |
@UziTech Interesting. How does it look now? |
README.md
Outdated
- ⚡ built for speed | ||
- ⬇️ low-level markdown compiler for parsing without caching or blocking for long periods of time | ||
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications | ||
- 🌐 works in the browser, on the server, or on the command line interface (CLI) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"...or through a command line interface" ??
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here’s how I think:
- You run code in the browser
- You run code on the server
- You run code on the command line
- You run code from the command line
- You run code through a command line
I think “from” might be best here.
@UziTech Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"from" sound best to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅ Done
README.md
Outdated
- ⚡ built for speed | ||
- ⬇️ low-level markdown compiler for parsing without caching or blocking for long periods of time | ||
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications | ||
- 🌐 works in the browser, on the server, or from the command line interface (CLI) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should "the" be changed to "a"
- 🌐 works in a browser, on a server, or from a command line interface (CLI)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅ Sure thing
/cc @joshbruce |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My designer brain wants to modify the first two for consistency but not a deal-breaker as I'm not sure what's available from the default set. :)
Update readme with emoji
Description
🌶 Spice up the readme with emoji and logo
Contributor
Committer
In most cases, this should be a different person than the contributor.