From 08b1f17ad0839d2abc5c91eae61ab094a7be1401 Mon Sep 17 00:00:00 2001 From: softprops Date: Sun, 27 Oct 2019 19:03:46 -0400 Subject: [PATCH] document inputs in readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1cc95fa..46ecda5 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,16 @@ jobs: run: cargo test --verbose ``` +## inputs + +The following inputs can be provided with the `jobs..steps.with` yaml key. + +| Name | Required | Description | Type | Default | +|--------------|:--------:|--------------------------------------------------------|-------------------------|---------| +| rust-version | ✖ | The toolchain name, such as stable, nightly, or 1.8.0 | String | stable | +| components | ✖ | The toolchain components to install | String, comma-separated | | +| targets | ✖ | The toolchain targets to add | String, comma-separated | | + For more details, check out [`action.yml`]. [`action.yml`]: https://github.com/hecrj/setup-rust-action/blob/master/action.yml