Merge pull request #2 from roberth/update-readme

Update README.md, add lib/README.md
This commit is contained in:
Domen Kožar 2019-10-02 15:42:20 +02:00 committed by GitHub
commit ff1a6b6f95
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 3 deletions

View file

@ -2,7 +2,7 @@
![github actions badge](https://github.com/cachix/nix-action/workflows/nix-action%20test/badge.svg) ![github actions badge](https://github.com/cachix/nix-action/workflows/nix-action%20test/badge.svg)
Installs [Nix](https://nixos.org/nix/) in platform agnostic way (supports: Linux/macOS). Installs [Nix](https://nixos.org/nix/) on GitHub Actions for the supported platforms: Linux and macOS.
## Usage ## Usage
@ -29,7 +29,7 @@ simple binary cache setup.
## Hacking ## Hacking
Install the dependencies Install the dependencies
```bash ```bash
$ yarn install $ yarn install
``` ```
@ -39,7 +39,7 @@ Build the typescript
$ yarn build $ yarn build
``` ```
Run the tests :heavy_check_mark: Run the tests :heavy_check_mark:
```bash ```bash
$ yarn test $ yarn test
``` ```

5
lib/README.md Normal file
View file

@ -0,0 +1,5 @@
# Generated Code
The files in this directory are generated.
See [src](../src)