From aabb57321c055143bfae153ee858ef24f6de2c5a Mon Sep 17 00:00:00 2001
From: Alan Orth <alan.orth@gmail.com>
Date: Mon, 29 Jul 2019 11:15:51 +0300
Subject: [PATCH] README.md: Improve

Reorganize functionality section and add installation section.
---
 README.md | 34 ++++++++++++++++++++++++----------
 1 file changed, 24 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 174e6fa..db57261 100644
--- a/README.md
+++ b/README.md
@@ -3,19 +3,33 @@ A simple but opinionated metadata quality checker and fixer designed to work wit
 
 Written and tested using Python 3.7. CSV and Excel support comes from the [Pandas](https://pandas.pydata.org/) library.
 
-## Checks
-Supports checking the validity of the following metadata elements:
+## Functionality
 
-- ISSN
-- ISBN
-- Multi-value separators ("||")
-- Dates
+- Read/write CSV files ✓
+- Read Excel files ✓
+- Validate dates, ISSNs, ISBNs, and multi-value separators ("||") ✓
+- Fix leading, trailing, and excessive whitespace ✓
+- Fix invalid multi-value separators ("|") using `--unsafe-fixes` ✓
 
-## Fixes
-Supports fixing the following metadata issues:
+## Installation
+The easiest way to install CSV Metadata Quality is with [pipenv](https://github.com/pypa/pipenv):
 
-- Leading, trailing, and excessive whitespace
-- Invalid multi-value separators ("|") using `--unsafe-fixes`
+```
+$ git clone https://git.sr.ht/~alanorth/csv-metadata-quality
+$ cd csv-metadata-quality
+$ pipenv install
+$ pipenv shell
+```
+
+Otherwise, if you don't have pipenv, you can use a vanilla Python virtual environment:
+
+```
+$ git clone https://git.sr.ht/~alanorth/csv-metadata-quality
+$ cd csv-metadata-quality
+$ python3 -m venv venv
+$ source venv/bin/activate
+$ pip install -r requirements.txt
+```
 
 ## Todo