Initial commit

README.md

@@ -0,0 +1,45 @@
+# nix-action
+
+![github actions badge](https://github.com/cachix/nix-action/workflows/.github/workflows/test.yml/badge.svg)
+
+Installs [Nix](https://nixos.org/nix/) in platform agnostic way (supports: Linux/macOS).
+
+## Usage
+
+Create `.github/workflows/test.yml` in your repo with the following contents:
+
+```yaml
+name: "Test"
+on:
+  pull_request:
+  push:
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: cachix/nix-action@v1
+    - run: nix-build
+```
+
+See also [cachix-action](https://github.com/cachix/cachix-action) for
+simple binary cache setup.
+
+---
+
+## Hacking
+
+Install the dependencies  
+```bash
+$ yarn install
+```
+
+Build the typescript
+```bash
+$ yarn build
+```
+
+Run the tests :heavy_check_mark:  
+```bash
+$ yarn test
+```