diff --git a/README.md b/README.md index 1246247..57fae40 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,22 @@ ## Installation -Install from [GitHub releases](https://github.com/databio/bbconf/releases) or from PyPI using `pip`: +Currently, there's no released version since `bbconf` is under rapid development so the only way to install the package is: +1. Clone this repository +```bash +git clone https://github.com/databio/bbconf.git ``` -pip install --user bbconf +2. Install the local package +```bash +pip install ./bbconf ``` + + + + + ## Usage - [Usage demonstration](https://github.com/databio/bbconf/blob/master/docs/demo.ipynb)