From 01c39d70b1fa56c8f6259a3d9bcd5c724499f960 Mon Sep 17 00:00:00 2001 From: Cyril Sobierajewicz Date: Mon, 20 May 2019 14:18:57 +0200 Subject: Add installation instructions --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 22a06b6..8c03a70 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # node-dhall-json -NPM package for `dhall-json`, based on https://github.com/justinwoo/npm-psc-package-bin-simple. +NPM package for `dhall-json`, based on https://github.com/justinwoo/npm-psc-package-bin-simple. Linux and Windows only. + +## Installation + +: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). + +There’s two installation modes: + +### Locked + +``` +npm install --save-optional fretlink/node-dhall-json#v-- +``` + +This will install a specific version of `dhall-json`. Replace ``, `` and `` with appropriate versions of `dhall-json`, `dhall` and this package. + +See [the releases](https://github.com/fretlink/node-dhall-json/releases). + +### Dynamic + +``` +npm install --save-optional fretlink/node-dhall-json +``` + +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). -- cgit v1.2.3