rclone/vendor/github.com/jzelinskie/whirlpool/README.md

44 lines
874 B
Markdown
Raw Normal View History

2019-06-25 19:44:57 +02:00
# whirlpool.go
A [whirlpool hashing](https://en.wikipedia.org/wiki/Whirlpool_(cryptography)) library for go
## Build status
[![Build Status](https://secure.travis-ci.org/jzelinskie/whirlpool.png)](http://travis-ci.org/jzelinskie/whirlpool)
## Setup
```bash
$ go get github.com/jzelinskie/whirlpool
```
## Example
```Go
package main
import (
"fmt"
"github.com/jzelinskie/whirlpool"
)
func main() {
w := whirlpool.New()
text := []byte("This is an example.")
w.Write(text)
fmt.Println(w.Sum(nil))
}
```
## Docs
Check out the [gopkgdoc page](http://go.pkgdoc.org/github.com/jzelinskie/whirlpool), but there isn't much -- it works just like the other hashes in the standard library
## Branches
* master - stable, works like the hash libs in the corelib
* trace - same code as master, but prints midstate values to stdout
## license
Modified BSD License