Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Roberto Jimenez Sanchez committed Aug 23, 2016
1 parent ec807be commit 84dc0ba
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@
CLI tool to interact with Kindle vocabulary builder

Connect the Kindle to your USB port and run the binary.

```
$ chmod +x kindle-words
$ ./kindle-words -h
NAME:
kindle-words - Provides methods to work with vocabulary builder
USAGE:
kindle-words [global options] command [command options] [arguments...]
VERSION:
0.1.0
COMMANDS:
export Export words
delete-book Delete book
delete-word Delete word
books show book title
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--verbose Show more output
--help, -h show help
--version, -v print the version
```
**Important**: This has been only tested on Mac for the moment.

**Note**: Your Kindle must be restarted to see the changes.
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ func main() {
app.EnableBashCompletion = true
app.Name = "kindle-words"
app.Usage = "Provides methods to work with vocabulary builder "

app.Version = "0.1.0"
// global level flags
app.Flags = []cli.Flag{
cli.BoolFlag{
Expand Down

0 comments on commit 84dc0ba

Please sign in to comment.