Add Configuration section to README

Identifies all of the necessary steps to generate a consumer key
and get `pocket-cli` up and running.
This commit is contained in:
David Wittman 2016-08-16 16:11:32 -05:00
parent 9a94a1c33a
commit 4eba737f72
2 changed files with 14 additions and 0 deletions

View file

@ -24,6 +24,20 @@ Installation
pip install pocket-cli
Configuration
-------------
If you already have a Pocket API consumer key, skip to step 2.
1. Generate a Pocket API consumer key at https://getpocket.com/developer/apps/new. Here's an example:
![](/docs/create_consumer_key.png?raw=true)
2. Run `pocket-cli configure` and enter the consumer key generated in step 1 when prompted.
3. Next, you will be prompted for a sort order and your estimated reading speed. You may visit http://www.readingsoft.com/ to estimate your reading speed.
4. After you have finished selecting configurations for `pocket-cli`, a browser window will open requesting access to your Pocket account. Log in to Pocket (if you are not already logged in) and click **Authorize** to accept and complete the configuration of `pocket-cli`.
Usage
-----

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB