From f1b2266bb5d0fbe899522cae2f43394f14ea1de0 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Thu, 11 Feb 2016 19:56:16 -0500 Subject: [PATCH] Update README.rst --- README.rst | 47 +++++++++++++++++++++++------------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index 061c658..900754c 100644 --- a/README.rst +++ b/README.rst @@ -121,38 +121,37 @@ Of course, the recommended installation method is pip:: ------------------- As an added bonus, a `records` command-line tool is also included in -this distribution. Here's the usage, so you get an idea of it: +this distribution. Here's the usage, so you get an idea of it:: -``` -Records: SQL for Humans™ -A Kenneth Reitz project. + Records: SQL for Humans™ + A Kenneth Reitz project. -Usage: - records [-i] [--params ...] [--url=] - records (-h | --help) + Usage: + records [-i] [--params ...] [--url=] + records (-h | --help) -Options: - -h --help Show this screen. - --url= The database URL to use. Defaults to $DATABASE_URL. - --params Prameterized query. Subsequent arguments are treated as - parameters to the query. - -i --interactive An interactive interpreter. + Options: + -h --help Show this screen. + --url= The database URL to use. Defaults to $DATABASE_URL. + --params Prameterized query. Subsequent arguments are treated as + parameters to the query. + -i --interactive An interactive interpreter. -Supported Formats: - csv, tsv, json, yaml, html, xls, xlsx, dbf, latex, ods + Supported Formats: + csv, tsv, json, yaml, html, xls, xlsx, dbf, latex, ods Note: xls, xlsx, dbf, and ods formats are binary, and should only be used with redirected output e.g. '$ records sql xls > sql.xls'. -Notes: - - While you may specify a Postgres connection string with --url, records - will automatically default to the value of $DATABASE_URL, if available. - - Query is intended to be the path of a SQL file, however a query string - can be provided instead. Use this feature discernfully; it's dangerous. - - Records is intended for report-style exports of database queries, and - has not yet been optimized for extremely large data dumps. - - Interactive mode is experimental and may be removed at any time. - Feedback, as always, is much appreciated! --me@kennethreitz.org + Notes: + - While you may specify a Postgres connection string with --url, records + will automatically default to the value of $DATABASE_URL, if available. + - Query is intended to be the path of a SQL file, however a query string + can be provided instead. Use this feature discernfully; it's dangerous. + - Records is intended for report-style exports of database queries, and + has not yet been optimized for extremely large data dumps. + - Interactive mode is experimental and may be removed at any time. + Feedback, as always, is much appreciated! --me@kennethreitz.org Cake: ✨ 🍰 ✨