diff --git a/README.md b/README.md index 290d963..06cee9d 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,28 @@ This project contains two components: -| Component | Description | -|-----------|-------------| +| Component | Description | +| ----------------------------- | ---------------------------------------------------------- | | **NAPI addon** (`vp_release`) | Native Node.js addon built with [napi-rs](https://napi.rs) | -| **CLI** (`oxrls`) | Rust binary for release management | +| **CLI** (`oxrls`) | Rust binary for release management | ## Quick start +```bash +npm install @bdbchgg/oxrls --save-dev +``` + +Then add this to your `package.json` scripts: + +````json +{ + "scripts": { + "oxrls": "oxrls", # for convenience, you can run `npm run oxrls` instead of `npx oxrls` + "changeset": "oxrl new", # create a new release file (similar to `changeset add`) + "release": "oxrls release" # publish to npm (after bumping versions) + } +} + ```bash # Initialize oxrls init @@ -29,18 +44,18 @@ oxrls bump # Publish to npm oxrls release -``` +```` ## Commands -| Command | Description | -|---------|-------------| -| `oxrls init` | Create `oxrls.json` config and `.oxrls/` directory | -| `oxrls new` | Create a release file (interactive or `--package --summary`) | -| `oxrls status` | Show pending release files and calculated bumps | -| `oxrls bump` | Apply version bumps, update deps, generate changelogs | -| `oxrls release` | Publish bumped packages to npm | -| `oxrls pre` | Manage pre-release mode (interactive or `enter`/`exit`) | +| Command | Description | +| --------------- | ------------------------------------------------------------ | +| `oxrls init` | Create `oxrls.json` config and `.oxrls/` directory | +| `oxrls new` | Create a release file (interactive or `--package --summary`) | +| `oxrls status` | Show pending release files and calculated bumps | +| `oxrls bump` | Apply version bumps, update deps, generate changelogs | +| `oxrls release` | Publish bumped packages to npm | +| `oxrls pre` | Manage pre-release mode (interactive or `enter`/`exit`) | ## Documentation