diff --git a/README.md b/README.md index a6e3a04..0811fa8 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,36 @@ _____ _Batchee_ groups together filenames so that further operations (such as concatenation) can be performed separately on each group of files. + +## Installing +_____ + +For local development, one can clone the repository and then use poetry or pip from the local directory: + +```shell +git clone +``` + +###### (Option A) using poetry: +i) Follow the instructions for installing `poetry` [here](https://python-poetry.org/docs/). + +ii) Run ```poetry install``` from the repository directory. + +###### (Option B) using pip: Run ```pip install .``` from the repository directory. + +## Usage +_____ + +```shell +batchee [file_names ...] +``` + +###### Or, If installed using a `poetry` environment: +```shell +poetry run batchee [file_names ...] +``` + +#### Options + +- `-h`, `--help` show this help message and exit +- `-v`, `--verbose` Enable verbose output to stdout; useful for debugging