README.md in klipbook-3.0.0 vs README.md in klipbook-4.0.0
- old
+ new
@@ -10,18 +10,12 @@
<img src="https://github.com/grassdog/klipbook/raw/master/example.png" alt="Example
of a clippings file" />
## What sources does it support?
-Klipbook can take your highlights from a clippings file off a physical Kindle device or from the [Kindle highlights site](https://kindle.amazon.com/your_highlights) itself.
+Klipbook can take your highlights from a clippings file off a physical Kindle device.
-### When should I use the file and when should I use the site?
-
-If your books are purchased from Amazon directly then use the site. The site is the canonical source and will contain all of your notes and highlights from across all of your Kindle devices and applications. Currently the Amazon highlights site only shows clippings for books you've purchased on Amazon.
-
-If your books are personal documents and you've read them on your Kindle device itself then you should use the file from that device as a source i.e. your Kindle device only keeps clippings that you make directly on it.
-
## How does it work?
Klipbook supports two commands: `list` and `export`.
`list` shows the books in the specified source and `export` exports books to a different format.
@@ -35,23 +29,13 @@
Copy your clippings file (called "My Clippings.txt" on a 3rd generation Kindle) from your Kindle device to your local drive via USB.
Then specify the path to your clippings via:
```sh
-$ klipbook --from-file "My Clippings.txt"
+$ klipbook list --from-file "My Clippings.txt"
```
-### Reading from the highlights site
-
-Specify your Amazon credentials to klipbook and it will scrape the site and output a clippings file.
-
-```sh
-$ klipbook --from-site my-username@blah.com:my-password
-```
-
-Note that the scraping requires a network connection (obviously) and can take a while so please be patient.
-
## List
The `list` command lists the books available in the specified source.
```sh
@@ -77,27 +61,27 @@
### Export to Html
You can export clippings into a pretty html file for each book.
```sh
-$ klipbook export ---from-file "My Clippings.txt" --output-format html
+$ klipbook export --from-file "My Clippings.txt" --format html
```
### Export to JSON
You can export clippings into a JSON file for each book.
```sh
-$ klipbook export --from-file "My Clippings.txt" --output-format json
+$ klipbook export --from-file "My Clippings.txt" --format json
```
### Export to Markdown
You can export clippings into a markdown file for each book.
```sh
-$ klipbook export --from-file "My Clippings.txt" --output-format markdown
+$ klipbook export --from-file "My Clippings.txt" --format markdown
```
## Set defaults
If you don't feel like having your Amazon credentials in your shell history you can set your default source in the klipbook rc file: `~/.klipbookrc`.
@@ -105,11 +89,10 @@
This is a YAML file and you can specify default values for the source and the output directory (note the use of snake case) e.g.
```sh
$ cat ~/.klipbookrc
-:from_site: my-username@blah.com:my-password
:output_dir: /path/to/my/default/output/directory
```
Command line options override the defaults stored in the rc file.
@@ -125,14 +108,14 @@
Klipbook has been tested on clippings files from 3rd generation Kindles and the Kindle Touch.
## Tested platforms
-Klipbook has been tested on Mac OS X El Capitan using Ruby 2.3.1.
+Klipbook has been tested on Mac OS High Sierra using Ruby 2.5.1.
## 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.
## Copyright
-Copyright (c) 2016 Ray Grasso. See LICENSE.txt for further details.
+Copyright (c) 2018 Ray Grasso. See LICENSE.txt for further details.