-
Notifications
You must be signed in to change notification settings - Fork 3
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
Rework README file #14
Conversation
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.
Thanks again! I only have some rough notes for now
README.md
Outdated
{ | ||
// yada yada ... | ||
"scripts": { | ||
"build": "deno2node <tsConfigFilePath>" |
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.
Nitpick: I usually use prepare
, because npm invokes it installing from GitHub. yarn invokes prepack
.
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.
prepare
has several use cases, as it is also invoked automatically. Users who know this are able to adjust the example, others will appreciate a descriptive name.
That being said, it's obviously your choice 😉
d7d8886
to
5c41be8
Compare
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.
Please review @KnorpelSenf
Co-authored-by: Wojciech Pawlik <woj.pawlik@gmail.com>
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.
I'd rather stick with English title capitalisation standards.
Co-authored-by: KnorpelSenf <shtrog@gmail.com>
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.
Merge!
These docs are good enough to be merged as-is IMO, but feel free to change anything as you wish. This README can just as well serve as a starting point.