From 7f2ec0f3671ee7bcc9306e04336d5b28b123932c Mon Sep 17 00:00:00 2001 From: David Tolnay Date: Sat, 9 Oct 2021 05:15:41 +0100 Subject: [PATCH] Add readme --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..76c190e --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Install Rust Toolchain + +This GitHub Action installs a Rust toolchain using rustup. It is designed for +one-line concise usage. + +## Example workflow + +```yaml +name: test suite +on: [push, pull_request] + +jobs: + test: + name: cargo test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: dtolnay/rust-toolchain@stable + - run: cargo test --all-features +``` + +The selection of Rust toolchain is made based on the particular @rev of this +Action being requested. For example "dtolnay/rust-toolchain@nightly" pulls in +the nightly Rust toolchain, while "dtolnay/rust-toolchain@1.42.0" pulls in +1.42.0. + +## Inputs + +All inputs are optional. + +| Name | Description | +| ------------ | -----------------------------------------------------------------------------------------------------------------------------------| +| `toolchain` | Rustup toolchain specifier, ex. `stable`, `nightly`, `1.42.0`. **Important: the default is to match the @rev as described above.** | +| `target` | Additional target support to install, ex. `wasm32-unknown-unknown` | +| `components` | Comma-separated string of additional components to install, ex. `clippy, rustfmt` | + +## License + +The scripts and documentation in this project are released under the [MIT +License]. + +[MIT License]: LICENSE