Skip to content

docs: added setup instructions to readme#202

Merged
marionebl merged 1 commit intoconventional-changelog:masterfrom
pixelass:docs/local-setup
Dec 21, 2017
Merged

docs: added setup instructions to readme#202
marionebl merged 1 commit intoconventional-changelog:masterfrom
pixelass:docs/local-setup

Conversation

@pixelass
Copy link
Copy Markdown
Contributor

Description

Added a section under 'getting started'.
The basic setup is now available in a code block.

Motivation and Context

The setup was hard to find. IMHO this essential example should be shown in the readme.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

the npm-script recomendation is available in the readme. (previously hard to find)
@marionebl marionebl merged commit d82cbd4 into conventional-changelog:master Dec 21, 2017
@marionebl
Copy link
Copy Markdown
Contributor

Thanks!

@pixelass pixelass deleted the docs/local-setup branch January 17, 2018 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants