Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
muesli committed Feb 2, 2022
1 parent 24a5c5b commit b41561f
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
toktok
======

[![Latest Release](https://img.shields.io/github/release/muesli/toktok.svg)](https://github.com/muesli/toktok/releases)
[![Build Status](https://travis-ci.org/muesli/toktok.svg?branch=master)](https://travis-ci.org/muesli/toktok)
[![Coverage Status](https://coveralls.io/repos/github/muesli/toktok/badge.svg?branch=master)](https://coveralls.io/github/muesli/toktok?branch=master)
[![Go ReportCard](https://goreportcard.com/badge/muesli/toktok)](https://goreportcard.com/report/muesli/toktok)
Expand All @@ -14,17 +15,17 @@ guarantees a safety distance between the tokens, so they become resilient to typ

## Installation

Make sure you have a working Go environment (Go 1.5 or higher is required).
Make sure you have a working Go environment (Go 1.11 or higher is required).
See the [install instructions](https://golang.org/doc/install.html).

To install toktok, simply run:

go get github.com/muesli/toktok

To compile it from source:
Compiling toktok is easy, simply run:

cd $GOPATH/src/github.com/muesli/toktok
go get -u -v
git clone https://github.com/muesli/toktok.git
cd toktok
go build && go test -v

## Example
Expand Down Expand Up @@ -68,3 +69,10 @@ Generated Token 2: WNANK4FU
Generated Token 9: Y3NCDFWN
Best match for '_3NCDFW_' is token 'Y3NCDFWN' with distance 4
```

## Feedback

Got some feedback or suggestions? Please open an issue or drop me a note!

* [Twitter](https://twitter.com/mueslix)
* [The Fediverse](https://mastodon.social/@fribbledom)

0 comments on commit b41561f

Please sign in to comment.