diff options
author | Cyril Sobierajewicz <cyril.sobierajewicz@fretlink.com> | 2019-05-20 14:18:57 +0200 |
---|---|---|
committer | Cyril Sobierajewicz <cyril.sobierajewicz@fretlink.com> | 2019-05-20 14:18:57 +0200 |
commit | 01c39d70b1fa56c8f6259a3d9bcd5c724499f960 (patch) | |
tree | 74b344b29578e19bf47b471b93cefbd10694c7f6 | |
parent | ad5d20014bc73a09415569cd1c66b553f6afd34d (diff) | |
download | node-dhall-json-bin-01c39d70b1fa56c8f6259a3d9bcd5c724499f960.tar.gz node-dhall-json-bin-01c39d70b1fa56c8f6259a3d9bcd5c724499f960.tar.zst node-dhall-json-bin-01c39d70b1fa56c8f6259a3d9bcd5c724499f960.zip |
Add installation instructions
-rw-r--r-- | README.md | 26 |
1 files changed, 25 insertions, 1 deletions
@@ -1,2 +1,26 @@ | |||
1 | # node-dhall-json | 1 | # node-dhall-json |
2 | NPM package for `dhall-json`, based on https://github.com/justinwoo/npm-psc-package-bin-simple. | 2 | NPM 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 | |||
8 | There’s two installation modes: | ||
9 | |||
10 | ### Locked | ||
11 | |||
12 | ``` | ||
13 | npm install --save-optional fretlink/node-dhall-json#v<dhall-json version>-<dhall version>-<package version> | ||
14 | ``` | ||
15 | |||
16 | This 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 | |||
18 | See [the releases](https://github.com/fretlink/node-dhall-json/releases). | ||
19 | |||
20 | ### Dynamic | ||
21 | |||
22 | ``` | ||
23 | npm install --save-optional fretlink/node-dhall-json | ||
24 | ``` | ||
25 | |||
26 | This 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). | ||