Skip to content

Commit 2f8c1b4

Browse files
committed
Update README formatting
1 parent 3f228a8 commit 2f8c1b4

File tree

1 file changed

+23
-37
lines changed

1 file changed

+23
-37
lines changed

README.md

Lines changed: 23 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,14 @@
1-
[BinderHub](https://github.com/jupyterhub/binderhub)
2-
====================================================
1+
# [BinderHub](https://github.com/jupyterhub/binderhub)
32

43
[![travis status](https://img.shields.io/travis/com/jupyterhub/binderhub/master?logo=travis)](https://travis-ci.com/jupyterhub/binderhub)
5-
64
[![Documentation Status](https://img.shields.io/readthedocs/binderhub?logo=read-the-docs)](https://binderhub.readthedocs.io/en/latest/)
7-
85
[![Latest chart development release](https://img.shields.io/badge/dynamic/json.svg?label=latest&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.binderhub.latest&colorB=orange)](https://jupyterhub.github.io/helm-chart/)
9-
106
[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/jupyterhub/binderhub/issues)
11-
127
[![Discourse](https://img.shields.io/badge/help_forum-discourse-blue.svg)](https://discourse.jupyter.org/c/binder/binderhub)
13-
148
[![Gitter](https://img.shields.io/badge/social_chat-gitter-blue.svg)](https://gitter.im/jupyterhub/binder)
15-
169
[![Contribute](https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter)](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md)
1710

18-
What is BinderHub?
19-
------------------
11+
## What is BinderHub?
2012

2113
**BinderHub** allows you to `BUILD` and `REGISTER` a Docker image from a
2214
Git repository, then `CONNECT` with JupyterHub, allowing you to create a
@@ -26,38 +18,35 @@ branch name, commit, or tag to serve.
2618

2719
BinderHub ties together:
2820

29-
- [JupyterHub](https://github.com/jupyterhub/jupyterhub) to provide a
30-
scalable system for authenticating users and spawning single user
31-
Jupyter Notebook servers, and
32-
- [Repo2Docker](https://github.com/jupyter/repo2docker) which
33-
generates a Docker image using a Git repository hosted online.
21+
- [JupyterHub](https://github.com/jupyterhub/jupyterhub) to provide a scalable
22+
system for authenticating users and spawning single user Jupyter Notebook
23+
servers, and
24+
- [Repo2Docker](https://github.com/jupyter/repo2docker) which generates a Docker
25+
image using a Git repository hosted online.
3426

3527
BinderHub is built with Python, kubernetes, tornado, npm, webpack, and
3628
sphinx.
3729

38-
Documentation
39-
-------------
30+
## Documentation
4031

4132
For more information about the architecture, use, and setup of
4233
BinderHub, see [the BinderHub
4334
documentation](https://binderhub.readthedocs.io).
4435

45-
Contributing
46-
------------
36+
## Contributing
4737

4838
To contribute to the BinderHub project you can work on:
4939

50-
- [answering questions others have](https://discourse.jupyter.org/),
51-
- writing documentation,
52-
- designing the user interface, or
53-
- writing code.
40+
- [answering questions others have](https://discourse.jupyter.org/),
41+
- writing documentation,
42+
- designing the user interface, or
43+
- writing code.
5444

5545
To see how to build the documentation, edit the user interface or modify
5646
the code see [the contribution
5747
guide](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md).
5848

59-
Installation
60-
------------
49+
## Installation
6150

6251
**BinderHub** is based on Python 3, it\'s currently only hosted on
6352
GitHub (pip release soon). However, it can be installed using `pip`:
@@ -67,24 +56,21 @@ GitHub (pip release soon). However, it can be installed using `pip`:
6756
See [the BinderHub documentation](https://binderhub.readthedocs.io) for
6857
a detailed guide on setting up your own BinderHub server.
6958

70-
Why BinderHub?
71-
--------------
59+
## Why BinderHub?
7260

7361
Collections of Jupyter notebooks are becoming more common in scientific
7462
research and data science. The ability to serve these collections on
7563
demand enhances the usefulness of these notebooks.
7664

77-
Who is BinderHub for?
78-
---------------------
65+
## Who is BinderHub for?
7966

80-
- **Users** who want to easily interact with computational
81-
environments that others have created.
82-
- **Authors** who want to create links that allow users to immediately
83-
interact with a computational enviroment that you specify.
84-
- **Deployers** who want to create their own BinderHub to run on
85-
whatever hardware they choose.
67+
- **Users** who want to easily interact with computational environments that
68+
others have created.
69+
- **Authors** who want to create links that allow users to immediately interact
70+
with a computational enviroment that you specify.
71+
- **Deployers** who want to create their own BinderHub to run on whatever
72+
hardware they choose.
8673

87-
License
88-
-------
74+
## License
8975

9076
See `LICENSE` file in this repository.

0 commit comments

Comments
 (0)