mCaptcha/pow_sha256-polyfill
2
0
Fork 0
Code Issues 1 Pull requests 3 Projects Releases Packages Wiki Activity

add README

Browse source
This commit is contained in:
Aravinth Manivannan 2021-12-07 19:10:38 +05:30
parent 8349cc8cdb
commit 76ff717acf
Signed by: realaravinth
GPG key ID: AD9F0F08E855ED88
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md Normal file
View file

@ -0,0 +1,27 @@
<div align="center">
<h1>PoW JavaScript library</h1>
<strong>JavaScript library to generate PoW for mCaptcha</strong>
[![0.1.0](https://img.shields.io/badge/TypeScript_docs-master-2b7489)](https://mcaptcha.github.io/pow_sha256-polyfill/)
![Build)](<https://github.com/mCaptcha/pow_sha256-polyfill/workflows/CI%20(Linux)/badge.svg>)
[![codecov](https://codecov.io/gh/mCaptcha/pow_sha256-polyfill/branch/master/graph/badge.svg)](https://codecov.io/gh/mCaptcha/pow_sha256-polyfill)
</div>
## Usage
To generate proof-of-work, per mCaptcha specification:
```typescript
import {generate_proof} from "@mcaptcha/pow_sha256-polyfill"; /* yet to
be published in npm */
let salt = "randomsaltvalueprovidedbymcaptcha";
let phrase = "randomphrasevalueprovidedbymcaptcha";
let difficulty = 50_000;
let work = await generate_proof(salt, phrase, difficulty);
```