Skip to content

Commit

Permalink
feat: add installation guide (#3)
Browse files Browse the repository at this point in the history
closes #2
  • Loading branch information
jmosawy authored May 8, 2021
1 parent a077c30 commit e7ce3d1
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,16 @@ An opinionated and re-usable [Semantic Release](https://github.com/semantic-rele

## Installation and usage

To be written...
1. Install `semantic-release` and `@jmosawy/semantic-release-config`:

```bash
npm i semantic-release @jmosawy/semantic-release-config -D
```

2. Extend `@jmosawy/semantic-release-config` in your [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):

```json
{
"extends": "@jmosawy/semantic-release-config"
}
```

0 comments on commit e7ce3d1

Please sign in to comment.