Skip to content

Commit

Permalink
changed: updated readme.md, #83, closes #138
Browse files Browse the repository at this point in the history
  • Loading branch information
MartijnR committed Nov 2, 2023
1 parent e319c97 commit 64a7780
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,7 @@ Live demo web application (meant for testing purposes only) that uses Enketo Val

#### Command-line Install

To make the `enketo-validate` command available from any folder on your machine.
```bash
$ npm install -g --production enketo-validate
```

Alternatively, you can clone the repo and run `npm install --production`. This will make the `./validate` command available from within the clone folder. Running `npm link` makes the `enketo-validate` command available from any folder on your machine.
Clone the repo and run `yarn install --production`. This will make the `./validate` command available from within the clone folder. Running `yarn link` makes the `enketo-validate` command available from any folder on your machine.

#### Command-line Use

Expand All @@ -45,16 +40,22 @@ Errors are returned to `stderr` and warnings to `stdout`. If there is no `stderr
$ enketo-validate --help
```

#### Command-line update

1. `npm install -g --production enketo-validate`

## As NodeJS module

#### Module installation

Add the following yarn resolutions to package.json:

```json
"resolutions": {
"nan": "^2.17.0",
"libxslt/nan": "^2.17.0",
"node1-libxmljsmt-myh/nan": "^2.17.0"
},
```

```bash
npm install enketo-validate --save
yarn add enketo-validate
```

#### Module Use
Expand Down

0 comments on commit 64a7780

Please sign in to comment.