Skip to content

Commit 0e50a22

Browse files
Update readme.
1 parent 0ba9d7a commit 0e50a22

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
# JSON-LD Signatures _(jsonld-signatures)_
1+
# JSON-LD Signatures _(@digitalcredentials/jsonld-signatures)_
22

3-
[![Build status](https://img.shields.io/github/workflow/status/digitalbazaar/jsonld-signatures/Node.js%20CI)](https://github.com/digitalbazaar/jsonld-signatures/actions?query=workflow%3A%22Node.js+CI%22)
4-
[![Coverage status](https://img.shields.io/codecov/c/github/digitalbazaar/jsonld-signatures)](https://codecov.io/gh/digitalbazaar/jsonld-signatures)
5-
[![Dependency Status](https://img.shields.io/david/digitalbazaar/jsonld-signatures.svg)](https://david-dm.org/digitalbazaar/jsonld-signatures)
6-
[![NPM Version](https://img.shields.io/npm/v/jsonld-signatures.svg)](https://npm.im/jsonld-signatures)
3+
[![NPM Version](https://img.shields.io/npm/v/@digitalcredentials/jsonld-signatures.svg)](https://npm.im/digitalcredentials/jsonld-signatures)
74

85
> An implementation of the Linked Data Signatures specification for JSON-LD, for Node.js and browsers.
96
@@ -19,17 +16,20 @@
1916

2017
## Version Compatibility
2118

19+
(Forked from [`jsonld-signatures` v9.0.0](https://github.com/digitalbazaar/jsonld-signatures)
20+
to provide TypeScript compatibility.)
21+
2222
`jsonld-signatures` **v9.0** is compatible with the following signature suites:
2323

24-
* [`ed25519-signature-2020`](https://github.com/digitalbazaar/ed25519-signature-2020)
24+
* [`ed25519-signature-2020`](https://github.com/digitalcredentials/ed25519-signature-2020)
2525
`>= 2.1.0`.
2626

2727
and the following related libraries:
2828

2929
* `crypto-ld` `>= 5.0.0` (and related key crypto suites such as
3030
[`ed25519-verification-key-2020`](https://github.com/digitalbazaar/ed25519-verification-key-2020)
3131
`>= 2.1.0`).
32-
* `vc-js` `>= 7.0` (currently, [branch `v7.x`](https://github.com/digitalbazaar/vc-js/pull/83))
32+
* `@digitalcredentials/vc` `>= 1.0`
3333

3434
## Background
3535

@@ -61,7 +61,7 @@ document.
6161
One common use case for creating these signatures is for use with
6262
[Verifiable Credentials](https://w3c.github.io/vc-data-model) (VCs). If you're
6363
working with those, you should use a higher-level library that's specifically
64-
made for that purpose, such as [`vc-js`](https://github.com/digitalbazaar/vc-js).
64+
made for that purpose, such as [`@digitalcredentials/vc`](https://github.com/digitalcredentials/vc-js).
6565
(Incidentally, `vc-js` uses this library, `jsonld-signatures`, under the hood.)
6666

6767
## Security
@@ -104,7 +104,7 @@ security, or business rules.
104104
To install locally (for development):
105105

106106
```
107-
git clone https://github.com/digitalbazaar/jsonld-signatures.git
107+
git clone https://github.com/digitalcredentials/jsonld-signatures.git
108108
cd jsonld-signatures
109109
npm install
110110
```
@@ -115,7 +115,7 @@ npm install
115115
Instead, it's generally used through an individual _crypto suite_.
116116
For detailed usage instructions, see the READMEs of the supported suites:
117117

118-
* [`Ed25519Signature2020`](https://github.com/digitalbazaar/ed25519-signature-2020)
118+
* [`Ed25519Signature2020`](https://github.com/digitalcredentials/ed25519-signature-2020)
119119
* [`Ed25519Signature2018`](https://github.com/digitalbazaar/ed25519-signature-2018)
120120

121121
Most of the usages with individual suites and key types will have elements in
@@ -129,7 +129,7 @@ common. You'll need to:
129129
them for (see section on Proof Purpose below), using a Controller Document
130130
(such as a DID Document or similar).
131131
* Pair those keys with a corresponding cryptographic Signature Suite.
132-
For greenfield development, we recommend the [`Ed25519Signature2020`](https://github.com/digitalbazaar/ed25519-signature-2020)
132+
For greenfield development, we recommend the [`Ed25519Signature2020`](https://github.com/digitalcredentials/ed25519-signature-2020)
133133
suite, and for legacy/compatibility work, you can use
134134
[`Ed25519Signature2018`](https://github.com/digitalbazaar/ed25519-signature-2018) suite.
135135
See also the [Choosing a Key Type](https://github.com/digitalbazaar/crypto-ld#choosing-a-key-type)
@@ -153,11 +153,7 @@ PRs accepted.
153153
If editing the Readme, please conform to the
154154
[standard-readme](https://github.com/RichardLitt/standard-readme) specification.
155155

156-
## Commercial Support
157-
158-
Commercial support for this library is available upon request from
159-
Digital Bazaar: support@digitalbazaar.com
160-
161156
## License
162157

163-
[New BSD License (3-clause)](LICENSE) © Digital Bazaar
158+
* MIT License - DCC - TypeScript compatibility.
159+
* New BSD License (3-clause) © 2020-2021 Digital Bazaar - Initial implementation.

0 commit comments

Comments
 (0)