Skip to content

fix(libnpmteam): update README #8291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wraithgar merged 1 commit into from
May 13, 2025
Merged

fix(libnpmteam): update README #8291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 9 additions & 25 deletions workspaces/libnpmteam/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,6 @@
library that provides programmatic access to the guts of the npm CLI's `npm
team` command and its various subcommands.

## Example

```javascript
const team = require('libnpmteam')

// List all teams for the @npm org.
console.log(await team.lsTeams('npm'))
```

## Publishing
1. Manually create CHANGELOG.md file
1. Commit changes to CHANGELOG.md
```bash
$ git commit -m "chore: updated CHANGELOG.md"
```
1. Run `npm version {newVersion}`
```bash
# Example
$ npm version patch
# 1. Runs `coverage` and `lint` scripts
# 2. Bumps package version; and **create commit/tag**
# 3. Runs `npm publish`; publishing directory with **unpushed commit**
# 4. Runs `git push origin --follow-tags`
```

## Table of Contents

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

`$ npm install libnpmteam`

### Example

```javascript
const team = require('libnpmteam')

// List all teams for the @npm org.
console.log(await team.lsTeams('npm'))
```

### API

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