diff --git a/README.md b/README.md new file mode 100644 index 0000000..ab51efe --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Nix Installer Action + +You can use `nix-installer` as a Github action like so: + +```yaml +on: + pull_request: + push: + branches: [main] + +jobs: + lints: + name: Build + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v3 + - name: Install Nix + uses: DeterminateSystems/nix-installer@main + with: + # Allow the installed Nix to make authenticated Github requests. + # If you skip this, you will likely get rate limited. + github-token: ${{ secrets.GITHUB_TOKEN }} + - name: Run `nix build` + run: nix build . +```