Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
raineorshine committed Sep 13, 2023
1 parent 925bb8f commit f513ea1
Showing 1 changed file with 18 additions and 20 deletions.
38 changes: 18 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@

- maintains existing semantic versioning _policies_, i.e. `"react": "^16.0.4"` to `"react": "^18.2.0"`.
- _only_ modifies package.json file. Run `npm install` to update your installed packages and package-lock.json.
- clean output
- sensible defaults
- lots of options for custom behavior
- sensible defaults, but highly customizable
- CLI and module usage
- compatible with `npm`, `yarn`, `pnpm`, `bun`
- compatible with: `npm`, `yarn`, `pnpm`, `deno`, `bun`

![npm-check-updates-screenshot](https://github.com/raineorshine/npm-check-updates/blob/main/.github/screenshot.png?raw=true)

Expand All @@ -36,7 +34,7 @@ npx npm-check-updates

## Usage

Show all new dependencies ([excluding peerDependencies](https://github.com/raineorshine/npm-check-updates/issues/951)) for the project in the current directory:
Show the latest versions of all project dependencies:

```sh
$ ncu
Expand Down Expand Up @@ -103,6 +101,21 @@ ncu '/^(?!react-).*$/' # mac/linux
ncu "/^(?!react-).*$/" # windows
```

## Interactive Mode

Choose which packages to update in interactive mode:

```sh
ncu --interactive
ncu -i
```

![ncu --interactive](https://user-images.githubusercontent.com/750276/175337598-cdbb2c46-64f8-44f5-b54e-4ad74d7b52b4.png)

Combine with `--format group` for a truly _luxe_ experience:

![ncu --interactive --format group](https://user-images.githubusercontent.com/750276/175336533-539261e4-5cf1-458f-9fbb-a7be2b477ebb.png)

## How dependency updates are determined

- Direct dependencies are updated to the latest stable version:
Expand Down Expand Up @@ -638,21 +651,6 @@ target: (dependencyName, [{ semver, version, operator, major, minor, patch, rele
<!-- END Advanced Options -->
## Interactive Mode
Choose which packages to update in interactive mode:
```sh
ncu --interactive
ncu -i
```
![ncu --interactive](https://user-images.githubusercontent.com/750276/175337598-cdbb2c46-64f8-44f5-b54e-4ad74d7b52b4.png)
Combine with `--format group` for a truly _luxe_ experience:
![ncu --interactive --format group](https://user-images.githubusercontent.com/750276/175336533-539261e4-5cf1-458f-9fbb-a7be2b477ebb.png)
## Config File
Use a `.ncurc.{json,yml,js,cjs}` file to specify configuration information.
Expand Down

0 comments on commit f513ea1

Please sign in to comment.