Skip to content

Commit b734099

Browse files
authored
fix(libnpmteam): update README (#8291)
- Move "Example" to proper place - Remove "Publishing" (probably copy pasta)
1 parent 5e1fed9 commit b734099

File tree

1 file changed

+9
-25
lines changed

1 file changed

+9
-25
lines changed

workspaces/libnpmteam/README.md

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,6 @@
88
library that provides programmatic access to the guts of the npm CLI's `npm
99
team` command and its various subcommands.
1010

11-
## Example
12-
13-
```javascript
14-
const team = require('libnpmteam')
15-
16-
// List all teams for the @npm org.
17-
console.log(await team.lsTeams('npm'))
18-
```
19-
20-
## Publishing
21-
1. Manually create CHANGELOG.md file
22-
1. Commit changes to CHANGELOG.md
23-
```bash
24-
$ git commit -m "chore: updated CHANGELOG.md"
25-
```
26-
1. Run `npm version {newVersion}`
27-
```bash
28-
# Example
29-
$ npm version patch
30-
# 1. Runs `coverage` and `lint` scripts
31-
# 2. Bumps package version; and **create commit/tag**
32-
# 3. Runs `npm publish`; publishing directory with **unpushed commit**
33-
# 4. Runs `git push origin --follow-tags`
34-
```
35-
3611
## Table of Contents
3712

3813
* [Installing](#install)
@@ -52,6 +27,15 @@ console.log(await team.lsTeams('npm'))
5227

5328
`$ npm install libnpmteam`
5429

30+
### Example
31+
32+
```javascript
33+
const team = require('libnpmteam')
34+
35+
// List all teams for the @npm org.
36+
console.log(await team.lsTeams('npm'))
37+
```
38+
5539
### API
5640

5741
#### <a name="opts"></a> `opts` for `libnpmteam` commands

0 commit comments

Comments
 (0)