Skip to content
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

Merged
merged 13 commits into from
Dec 4, 2021
Merged

Rework README file #14

merged 13 commits into from
Dec 4, 2021

Conversation

KnorpelSenf
Copy link
Collaborator

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.

Copy link
Owner

@wojpawlik wojpawlik left a 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 Show resolved Hide resolved
README.md Outdated
{
// yada yada ...
"scripts": {
"build": "deno2node <tsConfigFilePath>"
Copy link
Owner

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.

Copy link
Collaborator Author

@KnorpelSenf KnorpelSenf Sep 9, 2021

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 😉

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Owner

@wojpawlik wojpawlik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please review @KnorpelSenf

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Wojciech Pawlik <woj.pawlik@gmail.com>
Copy link
Collaborator Author

@KnorpelSenf KnorpelSenf left a 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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: KnorpelSenf <shtrog@gmail.com>
Copy link
Collaborator Author

@KnorpelSenf KnorpelSenf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge!

@wojpawlik wojpawlik merged commit 6dceb3a into main Dec 4, 2021
@wojpawlik wojpawlik deleted the rework-reamde branch December 4, 2021 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants