Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 718 Bytes

README.md

File metadata and controls

35 lines (24 loc) · 718 Bytes

VCX NodeJS Wrapper

This is a NodeJS wrapper for VCX library. VCX is the open-source library on top of Libindy which fully implements the credentials exchange.

Note: This library is currently in experimental state.

Contribution Guide

Make sure you have these packages installed:

  • StandardJS
  • Typescript
  • TSLint

Also this has a dependency on:

  • libvcx debian Because it creates a symlink (/usr/lib/libvcx.so)

Run this commands before submitting your PR:

npm run lint

Documentation:

Run these commands:

npm install
npm ci
npm run doc-gen
  • A directory will be created locally ./docs which contains an index.html file which can be used to navigate the generated documents.