From c018af3564ea9a94c3e2e757c7421ffcf9de5f9e Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Sat, 29 Jul 2017 16:42:14 -0700 Subject: [PATCH] Clean out README --- README.md | 35 +++++++---------------------------- 1 file changed, 7 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 7c607eae..ce6d7e85 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,22 @@ # jupyter-repo2docker -**jupyter-repo2docker**, a command line tool, builds a docker image from a git -repository and can push the image to a docker registry. + +[![Build Status](https://travis-ci.org/jupyter/repo2docker.svg?branch=master)](https://travis-ci.org/jupyter/repo2docker) + +**jupyter-repo2docker** is a tool to build, run and push docker images from source code repositories. ## Installation To install from pypi, the python packaging index: ```bash -python3 -m pip install jupyter-repo2docker +pip install jupyter-repo2docker ``` To install from source: ```bash -git clone https://github.com/jupyterhub/jupyter-repo2docker.git -cd jupyter-repo2docker +git clone https://github.com/jupyter/repo2docker.git +cd 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**. - -## Documentation - -[Creating a new builder](docs/source/builder.md)