Skip to content

Commit

Permalink
restructure readme, add note about deno
Browse files Browse the repository at this point in the history
  • Loading branch information
silverwind committed Dec 23, 2022
1 parent 316f9f5 commit c884b03
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,33 @@

`updates` is a CLI tool which checks for npm dependency updates of the current project and optionally updates `package.json`. It is highly configurable and is typically able to complete in less than a second.

## Usage
# Installation

```bash
# install globally
npm i -g updates

# or install locally as a devDependency and run via `npx updates`
npm i -D updates
```

Then, check for new updates:
```bash
updates
```
# Usage

Check for updates:

When changes are satisfactory, update `package.json` and reinstall modules:
```bash
updates -u && npm i
npx updates
```

To only reinstall modules when updates are available:
Update `package.json` and install new dependencies:

```bash
updates -uU && npm i
npx updates -u
npm i
```

On a CI, it might be desireable to fail a build when updates are available:
## Deno

There is experimental support for deno, run via:

```bash
updates -E
deno run -A npm:updates
```

## Options
Expand Down

0 comments on commit c884b03

Please # to comment.