From 0b6edde60c40a01d6708962ec5fe42caedeb7169 Mon Sep 17 00:00:00 2001 From: Brett Smith Date: Mon, 22 May 2017 11:24:43 -0400 Subject: [PATCH] README: Markup fixes throughout. --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 4299b72..ecd2375 100644 --- a/README.rst +++ b/README.rst @@ -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.