diff --git a/README.md b/README.md index f963942..e83e9c6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # brainglobe-utils Shared general purpose tools for the BrainGlobe project + +## Installation + +```bash +pip install brainglobe-utils +``` +To also include the dependencies required for `napari`, use: +```bash +pip install brainglobe-utils[napari] +``` + +For development, clone this repository and install the dependencies with one of the following commands: +```bash +pip install -e .[dev] +pip install -e .[dev,napari] +``` \ No newline at end of file