Skip to content

Commit

Permalink
Rearange README to move documentation and contributing up
Browse files Browse the repository at this point in the history
  • Loading branch information
betatim committed Apr 14, 2019
1 parent bedd544 commit 13552fa
Showing 1 changed file with 38 additions and 23 deletions.
61 changes: 38 additions & 23 deletions README.rst
Expand Up @@ -28,8 +28,8 @@
What is BinderHub?
------------------

**BinderHub** allows you to ``BUILD`` and ``REGISTER`` a Docker image using a
GitHub repository, then ``CONNECT`` with JupyterHub, allowing you to create a
**BinderHub** allows you to ``BUILD`` and ``REGISTER`` a Docker image from a
Git repository, then ``CONNECT`` with JupyterHub, allowing you to create a
public IP address that allows users to interact with the code and environment
within a live JupyterHub instance. You can select a specific branch name,
commit, or tag to serve.
Expand All @@ -43,8 +43,41 @@ BinderHub ties together:
- `Repo2Docker <https://github.com/jupyter/repo2docker>`_ which generates
a Docker image using a Git repository hosted online.

BinderHub is created using Python, kubernetes, tornado, and traitlets. As such,
it should be a familiar technical foundation for Jupyter developers.
BinderHub is built with Python, kubernetes, tornado, npm, webpack, and sphinx.


Documentation
-------------

For more information about the architecture, use, and setup of BinderHub, see
`the BinderHub documentation <https://binderhub.readthedocs.io>`_.


Contributing
------------

To contribute to the BinderHub project you can work on:

* `answering questions others have <https://discourse.jupyter.org/>`_,
* writing documentation,
* designing the user interface, or
* writing code.

To see how to build the documentation, edit the user interface or modify the
code see `the contribution guide <https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md>`_.


Installation
------------

**BinderHub** is based on Python 3, it's currently only hosted on GitHub
(pip release soon). However, it can be installed using ``pip``::

pip install git+https://github.com/jupyterhub/binderhub

See `the BinderHub documentation <https://binderhub.readthedocs.io>`_ for
a detailed guide on setting up your own BinderHub server.


Why BinderHub?
--------------
Expand All @@ -53,6 +86,7 @@ Collections of Jupyter notebooks are becoming more common in scientific research
and data science. The ability to serve these collections on demand enhances the
usefulness of these notebooks.


Who is BinderHub for?
---------------------
* **Users** who want to easily interact with computational environments that
Expand All @@ -62,25 +96,6 @@ Who is BinderHub for?
* **Deployers** who want to create their own BinderHub to run on whatever
hardware they choose.

Installation
------------

**BinderHub** is based on Python 3, it's currently only hosted on GitHub (pip release soon).
However, it can be installed using ``pip``::

pip install git+https://github.com/jupyterhub/binderhub
See `the BinderHub documentation <https://binderhub.readthedocs.io>`_ for a detailed guide on setting
up your own BinderHub server.

**Local development**: To run BinderHub locally in order to make contributions to the codebase,
see `the contribution guide <https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md>`_.

Documentation
-------------

For more information about the architecture, use, and setup of BinderHub, see
`the BinderHub documentation <https://binderhub.readthedocs.io>`_.

License
-------
Expand Down

0 comments on commit 13552fa

Please sign in to comment.