Skip to content

Commit

Permalink
Draft of <README.MD> for NPM (plume-sig#103)
Browse files Browse the repository at this point in the history
I believe these should be organized other way (divide the monorepo?). But @Divide-By-0 seems to really need something to start with rn
  • Loading branch information
skaunov authored Feb 29, 2024
1 parent a44d60c commit e956b27
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions javascript/README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
JavaScript implementation of the PLUME signature scheme.

## API
### sign(message, privateKey)
Signs a message using the provided private key.
* `message` - String message to sign
* `privateKey` - Hex private key

Returns the PLUME signature.

### `verify(message, publicKey, signature)`
Verifies a signature matches the message and public key.
* `message` - Original string message
* `publicKey` - Hex public key
* `signature` - PLUME signature

Returns true if the signature is valid, false otherwise.

### License
MIT

0 comments on commit e956b27

Please sign in to comment.