Skip to content

Improve documentation for published package#25

Merged
waldyrious merged 1 commit intomasterfrom
support/improve-documentation-for-published-package
Oct 14, 2019
Merged

Improve documentation for published package#25
waldyrious merged 1 commit intomasterfrom
support/improve-documentation-for-published-package

Conversation

@rplopes
Copy link
Copy Markdown
Contributor

@rplopes rplopes commented Oct 14, 2019 •
edited by waldyrious
Loading

Now that uphold-scripts is public and published on npmjs.com, there are some improvements we can do:

  • Update the documentation to suggest installing though npm and not through the direct git repo link
  • Add the repo identifier to package.json to have a link to it in https://npmjs.com

@rplopes rplopes added the support Internal enhancements label Oct 14, 2019
@rplopes rplopes self-assigned this Oct 14, 2019
waldyrious
waldyrious approved these changes Oct 14, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@waldyrious waldyrious left a comment

Choose a reason for hiding this comment

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

Good point 👍

@waldyrious waldyrious merged commit bff9c66 into master Oct 14, 2019
@waldyrious waldyrious deleted the support/improve-documentation-for-published-package branch October 14, 2019 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kurayama kurayama Awaiting requested review from kurayama

1 more reviewer

@waldyrious waldyrious waldyrious approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@rplopes rplopes

Labels

support Internal enhancements

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rplopes @waldyrious