aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 22a06b6..8c03a70 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
1# node-dhall-json 1# node-dhall-json
2NPM package for `dhall-json`, based on https://github.com/justinwoo/npm-psc-package-bin-simple. 2NPM package for `dhall-json`, based on https://github.com/justinwoo/npm-psc-package-bin-simple. Linux and Windows only.
3
4## Installation
5
6:warning: This package should be installed as an optional dependency until static macOS builds are available from [`dhall-haskell` releases](https://github.com/dhall-lang/dhall-haskell/releases).
7
8There’s two installation modes:
9
10### Locked
11
12```
13npm install --save-optional fretlink/node-dhall-json#v<dhall-json version>-<dhall version>-<package version>
14```
15
16This will install a specific version of `dhall-json`. Replace `<dhall-json version>`, `<dhall version>` and `<package version>` with appropriate versions of `dhall-json`, `dhall` and this package.
17
18See [the releases](https://github.com/fretlink/node-dhall-json/releases).
19
20### Dynamic
21
22```
23npm install --save-optional fretlink/node-dhall-json
24```
25
26This will install a version of `dhall-json` matching the `DHALL_JSON_VERSION` and `DHALL_VERSION` environment variables or the `dhall-json:dhall-json-version` and `dhall-json:dhall-version` [npm configuration settings](https://docs.npmjs.com/misc/config#per-package-config-settings).