From ac127e7f8a0b03641b3de5dd0e67bb8061c98a23 Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Mon, 29 Jul 2019 11:30:06 +0300 Subject: [PATCH] README.md: Add usage section --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index db57261..44efe52 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,19 @@ $ source venv/bin/activate $ pip install -r requirements.txt ``` +## Usage +Run CSV Metadata Quality with the `--help` flag to see available options: + +``` +$ python -m csv_metadata_quality --help +``` + +To validate and clean a CSV file you must specify input and output files using the `-i` and `-o` options. For example, using the included test file: + +``` +$ python -m csv_metadata_quality -i data/test.csv -o /tmp/test.csv +``` + ## Todo - Reporting / summary