@digitalbazaar/credentials-examples-context/README.md

VC Examples Context.

# @digitalbazaar/credentials-examples-context _(@digitalbazaar/credentials-examples-context)_

> A VC examples context.

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Developing](#developing)
- [Commercial Support](#commercial-support)
- [License](#license)

## Install

Requires Node.js 16+

To install via NPM:

```
npm install @digitalbazaar/credentials-examples-context
```

## Usage

```js
import vcExamplesCtx from '@digitalbazaar/credentials-examples-context';
// or
const vcExamplesCtx = require('@digitalbazaar/credentials-examples-context');
const {contexts, constants} = vcExamplesCtx;

vcExamplesCtx.CONTEXT_URL_V1
// 'https://www.w3.org/2018/credentials/examples/v1'

// get context data for a specific context
vcExamplesCtx.CONTEXT_V1
// full context object
```

This package can be used with bundlers, such as [webpack][], in browser
applications.

## API

The library exports the following properties:
- `CONTEXT_URL_V1` and `CONTEXT_V1` (it's recommended that context repositories
  only export one context).
- `constants`: A Object that maps constants to well-known context URLs. The
  main constant `CONTEXT_URL_V1` may be updated from time to time to the
  latest context location.
- `contexts`: A `Map` that maps URLs to full context data.

## Developing

WARNING: The `.jsonld` in `contexts/` is auto-generated by the `npm run build`
script, each time you run the test suite.

DO NOT edit it directly (or your changes will be quickly overwritten).
Instead, make all context changes to `js/context.js`.

## Commercial Support

Commercial support for this library is available upon request from
Digital Bazaar: support@digitalbazaar.com

## License

- BSD 3-Clause © Digital Bazaar
- See the [LICENSE](./LICENSE) file for details.

[webpack]: https://webpack.js.org/