Skip to content

Commit c5caee0

Browse files
committed
README
1 parent 92dabf6 commit c5caee0

2 files changed

Lines changed: 52 additions & 2 deletions

File tree

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
jwa-purejs
2+
===
3+
4+
A pure JavaScript implementation of the [RFC 7518][rfc7518] ES256 digital signature algorithm.
5+
6+
[![npm][npm-image]][npm-url]
7+
8+
---
9+
10+
This library is a drop-in replacement for the popular [jwa][jwa] package.
11+
12+
I wrote it to remove the dependency on **crypto-browserify**.
13+
14+
Installation
15+
---
16+
17+
yarn add jwa-purejs
18+
19+
Usage
20+
---
21+
22+
**webpack.config.js**
23+
24+
```js
25+
module.exports = {
26+
resolve: {
27+
alias: {
28+
jwa: 'jwa-purejs',
29+
}
30+
}
31+
}
32+
```
33+
34+
**webpack Command Line**
35+
36+
webpack --resolve-alias jwa=jwa-purejs
37+
38+
[jwa]: https://www.npmjs.com/package/jwa
39+
[npm-image]: https://img.shields.io/npm/v/jwa-purejs.svg?style=flat-square
40+
[npm-url]: https://www.npmjs.com/package/jwa-purejs
41+
[rfc7518]: https://tools.ietf.org/html/rfc7518#section-3.4

package.json

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
{
22
"name": "jwa-purejs",
3-
"version": "1.0.0",
4-
"description": "ES256",
3+
"version": "1.0.1",
4+
"description": "A pure JavaScript implementation of the RFC 7518 ES256 digital signature algorithm",
5+
"keywords": [
6+
"jwa",
7+
"es256",
8+
"ecdsa",
9+
"isomorphic"
10+
],
511
"main": "jwa.js",
12+
"files": [
13+
"jwa.js"
14+
],
615
"repository": "git@github.com:mvasilkov/jwa-purejs.git",
716
"author": "Mark Vasilkov (https://github.com/mvasilkov)",
817
"license": "MIT",

0 commit comments

Comments
 (0)