Updated README.md

This commit is contained in:
Harrison Deng 2025-01-09 16:08:44 +00:00
parent 1d531aff42
commit e66525d341

View File

@ -1,3 +1,12 @@
# FASTA-MLST
# autoMLST
A CLI tool for rapidly performing MLST typing via accessing pubMLST and InstitutPasteur MSLT databases.
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