diff --git a/README.md b/README.md index 1f79fbf..d7938c3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # bazelisk-action -Github Action for Bazelisk + +Installs bazelisk as a Github Action. + +## Usage + +``` +jobs: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Install Bazelisk + uses: vsco/bazelisk-action@v1.0.0 + with: + # [required] + # Version of Bazelisk we would like to install, defaults to 1.5.0 + version: '1.5.0' + # [required] + # Install path for Bazelisk binaries, defaults to ./.local/bin + bazel-install-path: './.local/bin' +``` + +## License + +The Javascript Github Action and any documentation is released under the MIT License. +Check LICENSE.md for more info.