Skip to content

Commit f9cd48a

Browse files
authored
Add badges (#160)
Add badges
2 parents 0eda26c + 0980b60 commit f9cd48a

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.rst

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,31 @@
22
Jupyter Server Proxy
33
====================
44

5+
|ReadTheDocs badge| |Travis badge| |PyPI badge| |Conda badge| |NPM badge|
6+
7+
.. |ReadTheDocs badge| image:: https://img.shields.io/readthedocs/jupyter-server-proxy?logo=read-the-docs
8+
:target: https://jupyter-server-proxy.readthedocs.io/
9+
10+
.. |Travis badge| image:: https://img.shields.io/travis/jupyterhub/jupyter-server-proxy/master.svg?logo=travis
11+
:target: https://travis-ci.org/jupyterhub/jupyter-server-proxy
12+
13+
.. |PyPI badge| image:: https://img.shields.io/pypi/v/jupyter-server-proxy.svg?logo=pypi
14+
:target: https://pypi.python.org/pypi/jupyter-server-proxy
15+
16+
.. |Conda badge| image:: https://img.shields.io/conda/vn/conda-forge/jupyter-server-proxy?logo=conda-forge
17+
:target: https://anaconda.org/conda-forge/jupyter-server-proxy
18+
19+
.. |NPM badge| image:: https://img.shields.io/npm/v/jupyterlab-server-proxy.svg?logo=npm
20+
:target: https://www.npmjs.com/package/jupyterlab-server-proxy
21+
522
Jupyter Server Proxy lets you run arbitrary external processes (such
623
as RStudio, Shiny Server, syncthing, PostgreSQL, etc) alongside your
724
notebook, and provide authenticated web access to them.
825

9-
**Note:** This project used to be called **nbserverproxy**. if you have an older
10-
version of nbserverproxy installed, remember to uninstall it before install
11-
jupyter-server-proxy - otherwise they may conflict
26+
**Note:** This project used to be called **nbserverproxy**. As
27+
nbserverproxy is an older version of jupyter-server-proxy, uninstall
28+
nbserverproxy before installing jupyter-server-proxy to avoid
29+
conflicts.
1230

1331
The primary use cases are:
1432

@@ -32,18 +50,26 @@ Install
3250
pip
3351
---
3452

35-
``pip install jupyter-server-proxy``
53+
.. code-block::
54+
55+
pip install jupyter-server-proxy
3656
3757
conda
3858
-----
3959

40-
``conda install jupyter-server-proxy -c conda-forge``
60+
.. code-block::
61+
62+
conda install jupyter-server-proxy -c conda-forge
4163
4264
src
4365
---
4466

45-
``pip install .``
67+
.. code-block::
68+
69+
pip install .
4670
4771
**Note:** if installing from source in editable mode: ``setup.py develop/pip install -e``, please explicitly install the server extensions:
4872

49-
``jupyter serverextension enable --sys-prefix jupyter_server_proxy``
73+
.. code-block::
74+
75+
jupyter serverextension enable --sys-prefix jupyter_server_proxy

0 commit comments

Comments
 (0)