diff --git a/README.md b/README.md new file mode 100644 index 0000000..6de0e33 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +
+ +Github action to install and run [aftman](https://github.com/LPGhatguy/aftman), a toolchain manager. + +## Usage +```yaml +steps: +- uses: actions/setup-aftman@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} +``` + +### Parameters +|name|description|default| +|---|---|---| +|`version`|`aftman` version in the form `vx.x.x`|-| +|`no-trust-check`|Whether to check trusts|`false`| +|`trusts`|List of trusted tools separated by spaces|-| +|`path`|Path to the `aftman.toml` directory|-| +|`token`|Github token from `secrets.GITHUB_TOKEN`|| + +## Credits +@nezuo - Installing `aftman` using `gh`