# BBS 2023 Data Integrity Cryptosuite _(@digitalbazaar/bbs-2023-cryptosuite)_

[![Build Status](https://img.shields.io/github/actions/workflow/status/digitalbazaar/bbs-2023-cryptosuite/main.yml)](https://github.com/digitalbazaar/bbs-2023-cryptosuite/actions/workflows/main.yml)
[![Coverage Status](https://img.shields.io/codecov/c/github/digitalbazaar/bbs-2023-cryptosuite)](https://codecov.io/gh/digitalbazaar/bbs-2023-cryptosuite)
[![NPM Version](https://img.shields.io/npm/v/@digitalbazaar/bbs-2023-cryptosuite.svg)](https://npm.im/@digitalbazaar/bbs-2023-cryptosuite)

> BBS 2023 Data Integrity Cryptosuite for use with jsonld-signatures.

## Table of Contents

- [Background](#background)
- [Security](#security)
- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [Commercial Support](#commercial-support)
- [License](#license)

## Background

For use with https://github.com/digitalbazaar/jsonld-signatures v11.2 and above.

See also related specs:

* [Verifiable Credential Data Integrity](https://w3c.github.io/vc-data-integrity/)

## Security

TBD

## Install

- Browsers and Node.js 18+ are supported.

To install from NPM:

```
npm install @digitalbazaar/bbs-2023-cryptosuite
```

To install locally (for development):

```
git clone https://github.com/digitalbazaar/bbs-2023-cryptosuite.git
cd bbs-2023-cryptosuite
npm install
```

## Usage

The following code snippet provides a complete example of digitally signing
a verifiable credential using this library:

```javascript
// ...
```

## Contribute

See [the contribute file](https://github.com/digitalbazaar/bedrock/blob/master/CONTRIBUTING.md)!

PRs accepted.

If editing the Readme, please conform to the
[standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## Commercial Support

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

## License

[New BSD License (3-clause)](LICENSE) © 2023 Digital Bazaar