NPO-Accounting/oxrlib
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: Markup fixes throughout.

Browse source
This commit is contained in:
Brett Smith 2017-05-22 11:24:43 -04:00
parent c8000a8a74
commit 0b6edde60c
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.rst
View file

@ -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.