Skip to content

Commit

Permalink
Extend installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nichtich authored Jun 6, 2024
1 parent ccf4f5c commit 1fb1ffe
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,17 @@ Several schema languages exist for JSON (JSON Schema), XML (XSD, DTD, Schematron

## Install

Requires Node >= 18.0.0. Installation of this module provides bare functionality for validating records, including the command line client [avram](#usage):
Requires Node >= 18.0.0 (possibly try [nvm](https://github.com/nvm-sh/nvm) to get a current version of Node). Installation of this module provides bare functionality for validating records, including the command line client [avram](#usage).

~~~sh
npm install avram
npm install -g avram
~~~

If
To process selected data formats in serialization forms other than JSON, install additional parsing libraries [marcjs](https://www.npmjs.com/package/marcjs) for MARC, [pica-data](https://www.npmjs.com/package/marcjs) for PICA and [csv-parse](https://www.npmjs.com/package/csv-parse) for CSV:

~~~sh
npm install marcjs
npm install pica-data
npm install csv-parse
npm install -g marcjs pica-data csv-parse
~~~

To also validate schema files, install additional libraries [ajv] and [ajv-formats]:
Expand All @@ -52,13 +51,13 @@ To also validate schema files, install additional libraries [ajv] and [ajv-forma
[ajv-formats]: https://www.npmjs.com/package/ajv-formats

~~~sh
npm install ajv ajv-formats
npm install -g ajv ajv-formats
~~~

To convert schema files to HTML, install additional library [ejs](https://ejs.co/):

~~~sh
npm install ejs
npm install -g ejs
~~~

## Usage
Expand Down

0 comments on commit 1fb1ffe

Please sign in to comment.