README.md in klipbook-2.0.0 vs README.md in klipbook-2.1.0
- old
+ new
@@ -25,45 +25,45 @@
itself then you should use the file from that device as a source i.e. your Kindle
device only keeps clippings that you made directly on it.
## How does it work?
-Klipbook supports three commands: `list`, `pprint`, and `collate`.
+Klipbook supports three commands: `list`, `tohtml`, and `tojson`.
-### Pretty print
+### To HTML
-`pprint` retrieves the clippings from your latest annotated books and writes them
+`tohtml` retrieves the clippings from your latest annotated books and writes them
out into a pretty html file for each book.
#### From a file
Copy your clippings file (called "My Clippings.txt" on a 3rd generation Kindle) from
your Kindle device to your local drive via USB.
Then write out a list of your clippings via:
```sh
-$ klipbook pprint "file:My Clippings.txt"
+$ klipbook tohtml -i "My Clippings.txt"
```
This command will write the collected clippings for the latest annotated book to a
file in the current directory. You can override the output directory with the
-`--output-dir` switch.
+`--outdir` switch.
You can also specify a maximum count of books you'd like collated with the
-`--num-books` switch.
+`--number` switch.
Klipbook will not overwrite an exiting file by default. You can change this with the
`--force` flag.
#### From the site
-Specify your Amazon username and password to klipbook and it will scrape the site and
+Specify your Amazon credentials to klipbook and it will scrape the site and
output a clippings file.
```sh
-$ klipbook pprint site:my-username@blah.com:my-password
+$ klipbook tohtml -c my-username@blah.com:my-password
```
The same flags above apply.
Note that the scraping requires a network connection (obviously) and can take a while
@@ -78,42 +78,42 @@
output directory, e.g.
```sh
$ cat ~/.klipbookrc
-:source: site:my-username@blah.com:my-password
-:output: /path/to/my/default/output/directory
+:credentials: my-username@blah.com:my-password
+:outdir: /path/to/my/default/output/directory
```
Command line options override the defaults stored in the rc file.
### List
The `list` command lists the books available in the specified source.
```sh
-$ klipbook list file:"My Clippings.txt"
+$ klipbook list -i "My Clippings.txt"
Book list:
[1] The Big Sleep by Raymond Chandler
[2] How to jump out of a plane without a parachute and survive by Rip Rockjaw
```
By default it will only list the latest book. This can be overrided with the
-`--num-books` switch.
+`--number` switch.
-### Collate
+### To JSON
-`collate` pulls together the clippings from your latest annotated books and combines
+`tojson` pulls together the clippings from your latest annotated books and combines
them into a single JSON file.
```sh
-$ klipbook collate -c books.json "file:My Clippings.txt"
+$ klipbook tojson -i "My Clippings.txt" -o books.json
```
You can rerun collate on an existing JSON file to add new books. By default existing
-books in the JSON file will not be overwritten. This can be changed with the `force`
+books in the JSON file will not be overwritten. This can be changed with the `--force`
flag.
## Installation
Klipbook is a Ruby gem. To install simply run:
@@ -127,15 +127,15 @@
Klipbook has been tested on clippings files from 3rd generation Kindles and the
Kindle Touch.
## Tested platforms
-Klipbook has been tested on Mac OSX Mountain Lion using MRI 1.9.3.
+Klipbook has been tested on Mac OSX Mavericks using MRI 2.0.0
## Contributing to Klipbook
Fork the project on [Github](https://github.com/grassdog/klipbook), add tests for
-your changes, and submit a well described pull request.
+your changes, and submit a well described pull request.
## Copyright
Copyright (c) 2013 Ray Grasso. See LICENSE.txt for further details.