Skip to content

Commit e03ade0

Browse files
committed
add disclaimer and forgotten version bump
1 parent c50adcf commit e03ade0

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
> Disclaimer: I wrote this library just for the purpose of diving into Go and it has not yet been full optimized.
2+
13
# pronwords [![GoDoc](https://godoc.org/github.com/rndstr/pronwords?status.svg)](https://godoc.org/github.com/rndstr/pronwords) [![Build Status](https://travis-ci.org/rndstr/pronwords.svg?branch=master)](https://travis-ci.org/rndstr/pronwords) [![Coverage](https://gocover.io/_badge/github.com/rndstr/pronwords)](https://gocover.io/github.com/rndstr/pronwords)
24

35
`pronwords` is a Go library and CLI about pronounceable words.
@@ -6,11 +8,11 @@
68
`pronwords` comes with a word generator and a scoring mechanism to compare the pronounceableness between words. It acts
79
upon a corpus from which it will attempt to deduct a score.
810

9-
The library does not come with a corpus but any list of words will suffice. A good starting point is the
11+
The library does not ship with a corpus but any list of words will suffice. A good starting point is the
1012
[5 character word list](http://www.poslarchive.com/math/scrabble/lists/common-5.html) from
1113
http://www.poslarchive.com/math/scrabble/lists/index.html
1214

13-
The package also comes with a CLI to use the library directly to generate pronounceable words. See `CLI Examples`
15+
The package also comes with a CLI to use the library directly to generate pronounceable words. See `CLI > Examples`
1416

1517
## Library
1618

pronwords/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ func determineThreshold(percentile, top int, g *pronwords.Generator, p *pronword
8989
func main() {
9090
app := cli.NewApp()
9191
app.Name = "pronwords"
92-
app.Version = "0.1.1"
92+
app.Version = "0.2.0"
9393
app.Usage = "find pronounceable words"
9494
app.Action = func(c *cli.Context) {
9595
g, err := createGenerator(c)

0 commit comments

Comments
 (0)