Skip to content

Commit

Permalink
Moar README.md fix 'em ups
Browse files Browse the repository at this point in the history
  • Loading branch information
hkeeler committed Oct 25, 2023
1 parent 5d85a33 commit d2288f4
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ submission. For details on this dataset and its validations, please see:

## Setup

The following setup must be completed to running the CLI utilities or doing any
The following setup must be completed prior to running the CLI utilities or doing any
development on the project.

### Pre-requisites
### Prerequisites

The following software packages are pre-requisites to installing this software.
The following software packages are prerequisites to installing this software.

- [Python](https://www.python.org/downloads/) version 3.11 or greater.
- [Poetry](https://python-poetry.org/docs/#installation) for Python package management.
Expand Down Expand Up @@ -80,6 +80,8 @@ $ cfpb-val validate --help

$ cfpb-val validate tests/data/sbl-validations-pass.csv

**Note:** No output is returned if the file contains no validations errors or warnings.

1. Validate file with findings, passing in LEI as context

$ cfpb-val validate tests/data/sbl-validations-fail.csv --context lei=000TESTFIUIDDONOTUSE
Expand Down

0 comments on commit d2288f4

Please sign in to comment.