From fbe8e2010e66b43b552257bd82b218da9d9bf368 Mon Sep 17 00:00:00 2001 From: Ross MacArthur Date: Fri, 27 Nov 2020 13:53:14 +0200 Subject: [PATCH] Update README to clarify `just-version` input --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8dcc5f0..e2eae5c 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,19 @@ This GitHub Action will install the latest release of the ### Inputs -| Name | Required | Description | Type | Default | -| -------------- | -------- | -------------------------------------------------------- | ------ | ------- | -| `just-version` | no | A valid semver specification for the version to install. | string | * | +| Name | Required | Description | Type | Default | +| -------------- | -------- | --------------------------------------- | ------ | ------- | +| `just-version` | no | A valid NPM-style semver specification. | string | * | +The semver specification is passed directly to NPM's [semver +package](https://www.npmjs.com/package/semver). This GitHub Action will install +the latest matching release. Examples include + +- `just-version: '*'` latest version (default). +- `just-version: '0.8'` equivalent to `>=0.8.0 <0.9.0`. +- `just-version: '0.8.x'` equivalent to `>=0.8.0 <0.9.0`. +- `just-version: '0.8.3'` equivalent to `=0.8.3`. +- `just-version: '^0.8.3'` equivalent to `>=0.8.3 <0.9.0`. ### Basic example