diff --git a/README.md b/README.md index cf92e37..5520ace 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ -# FASTA-MLST +# autoMLST -A CLI tool for rapidly performing MLST typing via accessing pubMLST and InstitutPasteur MSLT databases. \ No newline at end of file +A CLI/library for rapidly performing MLST typing via accessing pubMLST and InstitutPasteur MSLT databases. + +# Components + +## automlst.cli + +The command line interface, sets up very minimal and mostly makes calls to the library. Uses argparse and is split into two parts: + +- `automlst info`: Provides user information on available databases to pull from, and the schemas available. +- `automlst exactmatch`: Provides users the ability to request exact match results from a given database and schema