Changeset - 0b6edde60c40
[Not reviewed]
0 1 0
Brett Smith - 7 years ago 2017-05-22 15:24:43
brettcsmith@brettcsmith.org
README: Markup fixes throughout.
1 file changed with 4 insertions and 4 deletions:
0 comments (0 inline, 0 general)
README.rst
Show inline comments
...
 
@@ -11,14 +11,14 @@ It currently only supports OXR's "historical" API.
 
Getting started with the CLI tool
 
---------------------------------
 

	
 
oxrlib includes an `oxrquery` tool to access the OXR API directly from the command line.  By default, it reads your OXR credentials and other common configuration from `~/.config/oxrlib.ini`.  Copy `oxrlib_example.ini` from the source to `~/.config/oxrlib.ini`, then edit that file following the instructions in the comments.
 
oxrlib includes an ``oxrquery`` tool to access the OXR API directly from the command line.  By default, it reads your OXR credentials and other common configuration from ``~/.config/oxrlib.ini``.  Copy ``oxrlib_example.ini`` from the source to ``~/.config/oxrlib.ini``, then edit that file following the instructions in the comments.
 

	
 
Run `oxrquery --help` for instructions to use the tool.
 
Run ``oxrquery --help`` for instructions to use the tool.
 

	
 
Getting started with the library
 
--------------------------------
 

	
 
Here's an example of using the Python library, complete with caching results:
 
Here's an example of using the Python library, complete with caching results::
 

	
 
  from oxrlib import cache, loaders, rate
 

	
...
 
@@ -36,4 +36,4 @@ Here's an example of using the Python library, complete with caching results:
 
Running tests
 
-------------
 

	
 
Run `./setup.py test` from your checkout directory.
 
Run ``./setup.py test`` from your checkout directory.
0 comments (0 inline, 0 general)