Skip to content

Commit

Permalink
massage description a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
noway committed Nov 8, 2021
1 parent 1902664 commit b568070
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
# NZCP.js

A verification library for COVID-19 Vaccine Passes in New Zealand built on top of the [NZ Covid Pass Spec](https://github.com/minhealthnz/nzcovidpass-spec) provided by the Ministry of Health. All contributions welcome 🥳
A JavaScript implementation of [NZ COVID Pass](https://github.com/minhealthnz/nzcovidpass-spec) verification, New Zealand's proof of COVID-19 vaccination solution, written in TypeScript. All contributions welcome 🥳

> This library can be used for both Client and Server-side implementations.
## Install

```bash
# NPM
npm i __package-name__
npm i @vaxxnz/nzcp

# Yarn
yarn add __package-name__
yarn add @vaxxnz/nzcp
```

Peer dependencies on: cbor, did-resolver, elliptic, rfc4648, web-did-resolver

## Usage

```javascript
import { verifyPass } from "__package-name__";
import { verifyPass } from "@vaxxnz/nzcp";

// Verify a New Zealand COVID-19 Pass
const result = await verifyPass("NZCP:/1/2KCEVIQEIVVWK6...");
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@vaxxnz/nzcp",
"version": "0.0.1",
"description": "Javascript implemtation of the NZ covid pass verifier spec",
"description": "A JavaScript implementation of the NZ COVID Pass verification",
"author": "vaxxnz <[email protected]>",
"repository": "https://github.com/vaxxnz/nzcp-js",
"license": "MIT",
Expand Down

0 comments on commit b568070

Please sign in to comment.