Skip to content

Commit 736de3c

Browse files
committed
also updated documentation
1 parent bbd1d00 commit 736de3c

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* [Native builds](#native-builds)
1616
* [Cross-platform matrix](#cross-platform-matrix)
1717
* [Compilation from source](#compilation-from-source)
18+
* [Using nightly builds](#using-nightly-builds)
1819
* [Options](#options)
1920
* [Supported Platforms](#supported-platforms)
2021
* [License](#license)
@@ -119,13 +120,23 @@ jobs:
119120
artifact_version: "0.9.85"
120121
```
121122

123+
### Using nightly builds
124+
125+
```yaml
126+
- name: Install Arturo (nightly)
127+
uses: arturo-lang/setup-arturo@v2
128+
with:
129+
token: ${{ secrets.GITHUB_TOKEN }}
130+
from: latest # Use nightly builds instead of stable
131+
```
132+
122133
## Options
123134

124135
| Option | Values | Default | Notes |
125136
|--------|--------|---------|-------|
126137
| `token` | GitHub token | *required* | Use `${{ secrets.GITHUB_TOKEN }}` |
127-
| `do` | `fetch`, `compile` | `fetch` | Fetch nightly or compile from source |
128-
| `from` | `latest`, `stable` | `latest` | Source repository for fetch mode |
138+
| `do` | `fetch`, `compile` | `fetch` | Fetch release or compile from source |
139+
| `from` | `latest`, `stable` | `stable` | Source repository for fetch mode (`latest` = nightly builds) |
129140
| `mode` | `mini`, `full` | `full` | Build configuration |
130141
| `os` | `linux`, `windows`, `macos`, `freebsd`, `web` | auto-detect | Target platform |
131142
| `arch` | `amd64`, `arm64`, `js` | auto-detect | Target architecture |
@@ -162,4 +173,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
162173

163174
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
164175

165-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
176+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)