Skip to content

Commit ab46b05

Browse files
committed
docs: add basic readme
1 parent 95cb19f commit ab46b05

File tree

3 files changed

+427
-4
lines changed

3 files changed

+427
-4
lines changed

README.md

+35-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
1-
# npm
1+
# @semrel-extra/npm
22
Drop-in-repl npm plugin to handle `npm-whoami` throttling issue for monorepos: https://github.com/semantic-release/npm/issues/414
3+
4+
### Install
5+
```shell
6+
npm i -D @semrel-extra/npm
7+
```
8+
9+
### Usage
10+
`@semrel-extra/npm` is just a wrapper, so it inherits the API contract of [@semantic-release/npm](https://github.com/semantic-release/npm).
11+
Follow [its docs](https://github.com/semantic-release/npm/blob/master/README.md):
12+
13+
| Step | Description |
14+
|--------------------|-------------|
15+
| `verifyConditions` | Verify the presence of the `NPM_TOKEN` environment variable, or an `.npmrc` file, and verify the authentication method is valid. |
16+
| `prepare` | Update the `package.json` version and [create](https://docs.npmjs.com/cli/pack) the npm package tarball. |
17+
| `addChannel` | [Add a release to a dist-tag](https://docs.npmjs.com/cli/dist-tag). |
18+
| `publish` | [Publish the npm package](https://docs.npmjs.com/cli/publish) to the registry. |
19+
20+
```json
21+
{
22+
"plugins": [
23+
"@semantic-release/commit-analyzer",
24+
["@semrel-extra/npm", {
25+
...
26+
}],
27+
["@semantic-release/git", {
28+
"assets": ["package.json", "npm-shrinkwrap.json"]
29+
}]
30+
]
31+
}
32+
33+
```
34+
35+
### License
36+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)