Skip to content

Commit e7ce3d1

Browse files
authored
feat: add installation guide (#3)
closes #2
1 parent a077c30 commit e7ce3d1

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,16 @@ An opinionated and re-usable [Semantic Release](https://github.com/semantic-rele
99

1010
## Installation and usage
1111

12-
To be written...
12+
1. Install `semantic-release` and `@jmosawy/semantic-release-config`:
13+
14+
```bash
15+
npm i semantic-release @jmosawy/semantic-release-config -D
16+
```
17+
18+
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):
19+
20+
```json
21+
{
22+
"extends": "@jmosawy/semantic-release-config"
23+
}
24+
```

0 commit comments

Comments
 (0)