From 16a36077c0d51223548190eedd1c8bd77a29ceba Mon Sep 17 00:00:00 2001 From: Nathan Self Date: Fri, 6 Nov 2020 11:31:42 -0500 Subject: [PATCH] Remove apostrophes from config example, add app registration details --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 33919c0..321219b 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,14 @@ pip install git+https://github.com/Linusp/python-inoreader.git ## Usage -1. [Register your application](https://www.inoreader.com/developers/register-app) and then create configuration file `$HOME/.inoreader` +1. [Register your application](https://www.inoreader.com/developers/register-app). Use `http://localhost:8080/oauth/redirect` for the redirect URI and set scope to "Read and Write". Then create the configuration file `$HOME/.inoreader` An example of the configuration file: ``` [auth] - appid = 'Your App ID' - appkey = 'Your App key' + appid = your_app_id + appkey = your_app_key ``` 2. Login to your Inoreader account @@ -37,4 +37,9 @@ pip install git+https://github.com/Linusp/python-inoreader.git inoreader login ``` -2. Use the command line tool `inoreader` to do something, run `inoreader --help` for details +2. Use the command line tool `inoreader` to do something, run `inoreader --help` for details. Or in code do: + + ```python + from inoreader.main import get_client + client = get_client() + ```