Add readme to hebe-node

This commit is contained in:
Mikołaj Pich 2020-03-14 19:42:40 +01:00
parent 0e816cccb6
commit a3e125e182
2 changed files with 26 additions and 1 deletions

25
hebe-node/README.md Normal file
View file

@ -0,0 +1,25 @@
# UONET+ hebe request signer for Node.js
[![npm](https://img.shields.io/npm/v/@wulkanowy/uonet-request-signer-node-hebe.svg?style=flat-square)](https://www.npmjs.com/package/@wulkanowy/uonet-request-signer-node-hebe)
## Instalation
```bash
$ npm i @wulkanowy/uonet-request-signer-node-hebe
```
## Usage
```js
const {getSignatureValues} = require("@wulkanowy/uonet-request-signer-node-hebe");
const {digest, canonicalUrl, signature} = getSignatureValues(fingerprint, privateKey, body, fullUrl, new Date().toUTCString());
```
See example in [tests](test.js)
## Tests
```bash
$ npm run test
```

View file

@ -1,6 +1,6 @@
{
"name": "@wulkanowy/uonet-request-signer-node-hebe",
"version": "0.1.0",
"version": "0.1.1",
"description": "UONET+ (hebe) request signer for Node.js",
"main": "signer.js",
"scripts": {