diff --git a/README.md b/README.md index b3fe7df4..92410444 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,39 @@ -## Builder +# jupyter-repo2docker -**Note**: The project will probably be renamed soon! +**jupyter-repo2docker**, a command line tool, builds a docker image from a git +repository and can push the image to a docker registry. -A simple commandline tool that builds a docker image off a git repository & pushes it to a docker registry. +## Installation -It mostly relies on other tools ([Source to Image](https://github.com/openshift/source-to-image) or just docker) -for doing the actual building. It is a simple wrapper that does detection to figure out which -build method to use, and how to invoke that build method. +To install from pypi, the python packaging index: + +```bash +python3 -m pip install jupyter-repo2docker +``` + +To install from source: + +```bash +git clone https://github.com/jupyterhub/jupyter-repo2docker.git +cd jupyter-repo2docker +python3 -m pip install . +``` + +## Usage + +To access help for the application: + + jupyter-repo2docker -h + +## Technical Overview for Contributors + +**jupyter-repo2docker** uses other tools +([Source to Image](https://github.com/openshift/source-to-image) or just docker) +for doing the actual building of the image. + +The `repo2docker` directory contains the application which detects which build +method to use, and how to invoke that build method. + +The `s2i-builders` directory contains builder images which can be used to +provide custom `conda` and `venv` environments suitable for running +**JupyterHub**.