Skip to content

Commit

Permalink
fix readme text
Browse files Browse the repository at this point in the history
  • Loading branch information
poing committed Jan 22, 2024
1 parent 7757905 commit d680aaf
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ Combing of shares is not working *yet*...

To use this project in it's current state **and for testing**, `Node` is required on the system. `Node` is always required for testing. It's used to run the `JavaScript` in the local environment.

## JavaScript Wrapper

The `JavaScript` wrapper **is not** intended to allow subsequent commands. It spawns an *indvidual* `subprocess` of `Node` for each function called.

```diff
import js2pysecrets

js2pysecrets.setRNG('testRandom')
- js2pysecrets.share('FFFF', 6, 3) # This will NOT use 'testRandom'
```

## Examples

Divide a 512-bit key, expressed in hexadecimal form, into 10 shares, requiring that any 5 of them are necessary to reconstruct the original key:
Expand Down

0 comments on commit d680aaf

Please sign in to comment.