Skip to content

Commit c15d40d

Browse files
committed
Update README
1 parent e6ac963 commit c15d40d

File tree

1 file changed

+7
-19
lines changed

1 file changed

+7
-19
lines changed

README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# setup-crate
22

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

55
This GitHub Action will install a release of a Rust crate for you.
66

@@ -47,26 +47,14 @@ input. For example the following installs the latest `0.10.x` version of
4747
version: 0.10
4848
```
4949

50-
In rare circumstances you might get rate limiting errors, this is because this
51-
workflow has to make requests to GitHub API in order to list available releases.
52-
If this happens you can set the `GITHUB_TOKEN` environment variable.
53-
54-
```yaml
55-
- uses: extractions/setup-crate@v1
56-
with:
57-
owner: rossmacarthur
58-
name: powerpack
59-
env:
60-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
61-
```
62-
6350
### Inputs
6451

65-
| Name | Required | Description | Type | Default |
66-
| --------- | -------- | --------------------------------------- | ------ | ------- |
67-
| `owner` | yes | The GitHub user or organization name | string | |
68-
| `name` | yes | The GitHub repository name | string | |
69-
| `version` | no | A valid NPM-style semver specification. | string | * |
52+
| Name | Required | Description | Type | Default |
53+
| -------------- | -------- | ---------------------------------------- | ------ | --------------------------- |
54+
| `owner` | yes | The GitHub user or organization name | string | |
55+
| `name` | yes | The GitHub repository name | string | |
56+
| `version` | no | A valid NPM-style semver specification | string | * |
57+
| `github-token` | no | The GitHub token for making API requests | string | ${{ secrets.GITHUB_TOKEN }} |
7058

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

0 commit comments

Comments
 (0)