<!-- @format -->

# @dwn-protocol/id

Code Coverage
![Statements](https://img.shields.io/badge/statements-91.74%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-94.6%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-92.5%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-91.74%25-brightgreen.svg?style=flat)

## Introduction

This repository contains ID++ v0.1.0 a reference implementation of Decentralized Web Node (DWN) as per the [specification](https://identity.foundation/decentralized-web-node/spec/). This specification is in a draft state. 
Proposals and issues for the specification itself should be submitted as pull requests.

## Documentation

* <a href="docs/index.html">ID Dwn Protocol</a>
* <a href="papers/ake.md">ID Authenticated Key Exchange</a>
* <a href="papers/lightpaper.md">ID Dwn Whitepaper</a>
* <a href="https://dwnprotocol.gitbook.io/id++-sdk-docs">ID SDK Docs</a>

## Installation

```bash
npm install @dwn-protocol/id
```

## Tests

To disable all tests

```bash
export TESTSOFF=true
```

Compile light paper from markdown notes

```sh
brew install quarto
quarto render lightpaper.md --to pdf
```

## Project Resources

| Resource                                   | Description                                                                    |
| ------------------------------------------ | ------------------------------------------------------------------------------ |
| [CODEOWNERS](./CODEOWNERS)                 | Outlines the project lead(s)                                                   |
| [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) | Expected behavior for project contributors, promoting a welcoming environment |
| [CONTRIBUTING.md](./CONTRIBUTING.md)       | Developer guide to build, test, run, access CI, chat, discuss, file issues     |
| [GOVERNANCE.md](./GOVERNANCE.md)           | Project governance                                                             |
| [LICENSE](./LICENSE)                       | Apache License, Version 2.0                                                    |
