Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rossmacarthur committed Feb 12, 2023
1 parent ad65954 commit 82fe2e1
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 🤖 `setup-just` action

![build](https://img.shields.io/github/workflow/status/extractions/setup-just/build)
[![Build Status](https://img.shields.io/github/actions/workflow/status/extractions/setup-just/build.yaml?branch=trunk)](https://github.com/extractions/setup-just/actions/workflows/build.yaml)

This GitHub Action will install a release of the
[just](https://github.com/casey/just) command runner for you.
Expand All @@ -24,17 +24,17 @@ If you want a specific version of `just` you can specify this by passing the
just-version: '1.4.0'
```

To avoid rate-limitting, the default Github token available to all actions, is
automatically used to authenticate calls to Github. To override it, set the environment
variable `GITHUB_TOKEN`.
To avoid rate-limiting, the default Github token available to all actions, is
automatically used to authenticate calls to Github. To override it, set the
environment variable `GITHUB_TOKEN` or pass the input `github-token`.

```yaml
- uses: extractions/setup-just@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

Alternatively, you may set the input `token`.
or

```yaml
- uses: extractions/setup-just@v1
Expand All @@ -44,10 +44,10 @@ Alternatively, you may set the input `token`.

### Inputs

| Name | Required | Description | Type | Default |
| -------------- | -------- | --------------------------------------- | ------ | --------------------- |
| `just-version` | no | A valid NPM-style semver specification. | string | * |
| `github-token` | no | A Github token. | string | `${{ github.token }}` |
| Name | Required | Description | Type | Default |
| -------------- | -------- | -------------------------------------------- | ------ | --------------------- |
| `just-version` | no | A valid NPM-style semver specification. | string | * |
| `github-token` | no | A Github token to authenticate API requests. | string | `${{ github.token }}` |

The semver specification is passed directly to NPM's [semver
package](https://www.npmjs.com/package/semver). This GitHub Action will install
Expand Down

0 comments on commit 82fe2e1

Please sign in to comment.