diff --git a/README.md b/README.md index 88ed63b..93644fa 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,23 @@ -Conda Buildpack -=============== +Miniconda Buildpack +=================== -This is a [Heroku Buildpack](https://devcenter.heroku.com/articles/buildpacks) for [Conda](http://docs.continuum.io/conda/), the Python distribution for scientific computing by Continuum Analytics. +This is a [Heroku Buildpack](https://devcenter.heroku.com/articles/buildpacks) for [Conda](http://conda.pydata.org/), the Python distribution for scientific computing by Continuum Analytics. -**Warning**: this buildpack is still a work in progress. +This buildpack enables the installation of binary packages through the +open source [conda](http://conda.pydata.org/) application. Conda is +recognized as being core to Continuum's Anaconda Scientific Python distro +but it's also at the heart of the lighter weight +[Miniconda](http://conda.pydata.org/miniconda.html) distro which we use +here to install _only_ the binary packages we need for our apps deployed +on Heroku. +To control what binary packages are installed by conda, supply a +`conda-requirements.txt` file (which can be created by capturing the output +of `conda list -e` for your working conda environment). +Like when using the standard buildpack for python from Heroku, you can also +still supply a `requirements.txt` file for [pip](https://github.com/pypa/pip) +to process. In this way, you can install binary packages via conda for +everything you can and still use pip for anything you can't. Usage -----