1
- # JSON-LD Signatures _ (jsonld-signatures)_
1
+ # JSON-LD Signatures _ (@ digitalcredentials/ jsonld-signatures )_
2
2
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 )
7
4
8
5
> An implementation of the Linked Data Signatures specification for JSON-LD, for Node.js and browsers.
9
6
19
16
20
17
## Version Compatibility
21
18
19
+ (Forked from [ ` jsonld-signatures ` v9.0.0] ( https://github.com/digitalbazaar/jsonld-signatures )
20
+ to provide TypeScript compatibility.)
21
+
22
22
` jsonld-signatures ` ** v9.0** is compatible with the following signature suites:
23
23
24
- * [ ` ed25519-signature-2020 ` ] ( https://github.com/digitalbazaar /ed25519-signature-2020 )
24
+ * [ ` ed25519-signature-2020 ` ] ( https://github.com/digitalcredentials /ed25519-signature-2020 )
25
25
` >= 2.1.0 ` .
26
26
27
27
and the following related libraries:
28
28
29
29
* ` crypto-ld ` ` >= 5.0.0 ` (and related key crypto suites such as
30
30
[ ` ed25519-verification-key-2020 ` ] ( https://github.com/digitalbazaar/ed25519-verification-key-2020 )
31
31
` >= 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 `
33
33
34
34
## Background
35
35
@@ -61,7 +61,7 @@ document.
61
61
One common use case for creating these signatures is for use with
62
62
[ Verifiable Credentials] ( https://w3c.github.io/vc-data-model ) (VCs). If you're
63
63
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 ) .
65
65
(Incidentally, ` vc-js ` uses this library, ` jsonld-signatures ` , under the hood.)
66
66
67
67
## Security
@@ -104,7 +104,7 @@ security, or business rules.
104
104
To install locally (for development):
105
105
106
106
```
107
- git clone https://github.com/digitalbazaar /jsonld-signatures.git
107
+ git clone https://github.com/digitalcredentials /jsonld-signatures.git
108
108
cd jsonld-signatures
109
109
npm install
110
110
```
@@ -115,7 +115,7 @@ npm install
115
115
Instead, it's generally used through an individual _ crypto suite_ .
116
116
For detailed usage instructions, see the READMEs of the supported suites:
117
117
118
- * [ ` Ed25519Signature2020 ` ] ( https://github.com/digitalbazaar /ed25519-signature-2020 )
118
+ * [ ` Ed25519Signature2020 ` ] ( https://github.com/digitalcredentials /ed25519-signature-2020 )
119
119
* [ ` Ed25519Signature2018 ` ] ( https://github.com/digitalbazaar/ed25519-signature-2018 )
120
120
121
121
Most of the usages with individual suites and key types will have elements in
@@ -129,7 +129,7 @@ common. You'll need to:
129
129
them for (see section on Proof Purpose below), using a Controller Document
130
130
(such as a DID Document or similar).
131
131
* 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 )
133
133
suite, and for legacy/compatibility work, you can use
134
134
[ ` Ed25519Signature2018 ` ] ( https://github.com/digitalbazaar/ed25519-signature-2018 ) suite.
135
135
See also the [ Choosing a Key Type] ( https://github.com/digitalbazaar/crypto-ld#choosing-a-key-type )
@@ -153,11 +153,7 @@ PRs accepted.
153
153
If editing the Readme, please conform to the
154
154
[ standard-readme] ( https://github.com/RichardLitt/standard-readme ) specification.
155
155
156
- ## Commercial Support
157
-
158
- Commercial support for this library is available upon request from
159
- Digital Bazaar: support@digitalbazaar.com
160
-
161
156
## License
162
157
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