Skip to content
This repository has been archived by the owner on Apr 29, 2022. It is now read-only.

Commit

Permalink
GoDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
pedroalbanese committed Nov 9, 2021
1 parent 30d24c2 commit 131811b
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
@@ -1,10 +1,11 @@
secp256k1
=====

[![CircleCI](https://circleci.com/gh/sammyne/secp256k1.svg?style=svg)](https://circleci.com/gh/sammyne/secp256k1)
[![codecov](https://codecov.io/gh/sammyne/secp256k1/branch/master/graph/badge.svg)](https://codecov.io/gh/sammyne/secp256k1)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](https://github.com/sammyne/secp256k1/blob/master/LICENSE)
[![GoDoc](https://godoc.org/github.com/sammyne/secp256k1?status.png)](http://godoc.org/github.com/sammyne/secp256k1)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](https://github.com/pedroalbanese/secp256k1/blob/master/LICENSE.md)
[![GoDoc](https://godoc.org/github.com/pedroalbanese/secp256k1?status.png)](http://godoc.org/github.com/pedroalbanese/secp256k1)
[![Go Report Card](https://goreportcard.com/badge/github.com/pedroalbanese/secp256k1)](https://goreportcard.com/report/github.com/pedroalbanese/secp256k1)
[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/pedroalbanese/secp256k1)](https://golang.org)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/pedroalbanese/secp256k1)](https://github.com/pedroalbanese/secp256k1/releases)

Package secp256k1 implements elliptic curve cryptography needed for working with
Bitcoin (secp256k1 only for now). It is designed so that it may be used with the
Expand Down Expand Up @@ -64,6 +65,28 @@ verify the signature perform the following:
git tag -v TAG_NAME
```

## Command

<pre>Usage of secp256k1:
-dec
Decrypt with Privatekey.
-derive
Derive shared secret key.
-enc
Encrypt with Publickey.
-key string
Private/Public key.
-keygen
Generate keypair.
-pub string
Remote's side Public key.
-sign
Sign with Private key.
-signature string
Signature.
-verify
Verify with Public key.</pre>

## License

Package secp256k1 is licensed under the [copyfree](http://copyfree.org) ISC License
Expand Down

0 comments on commit 131811b

Please sign in to comment.