Skip to content

Commit 50918d3

Browse files
committed
Merge pull request #301 from willingc/update-read
Update README and add @captainsafia suggestions
2 parents 9992d7c + 6836a47 commit 50918d3

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# Interactive HTML Widgets
22

3-
[![Build Status](https://travis-ci.org/ipython/ipywidgets.svg?branch=master)](https://travis-ci.org/ipython/ipywidgets) [![Join the chat at https://gitter.im/ipython/ipywidgets](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ipython/ipywidgets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
3+
[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)
4+
[![Build Status](https://travis-ci.org/ipython/ipywidgets.svg?branch=master)](https://travis-ci.org/ipython/ipywidgets)
5+
[![Documentation Status](https://readthedocs.org/projects/ipywidgets/badge/?version=latest)](http://ipywidgets.readthedocs.org/en/latest/?badge=latest)
6+
[![Join the chat at https://gitter.im/ipython/ipywidgets](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ipython/ipywidgets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
47

5-
[Interactive HTML widgets](https://github.com/ipython/ipywidgets/blob/master/examples/notebooks/Index.ipynb) for Jupyter notebooks and the IPython kernel.
8+
[Interactive HTML widgets](https://github.com/ipython/ipywidgets/blob/master/examples/notebooks/Index.ipynb)
9+
for Jupyter notebooks and the IPython kernel.
10+
11+
A [demonstration notebook](https://github.com/ipython/ipywidgets/blob/master/examples/notebooks/Index.ipynb) provides an overview of the interactive widgets. For detailed information, please refer to the [ipywidgets documentation](http://ipywidgets.readthedocs.org/en/latest/).
612

713
## Install
814

9-
You can install the current version of ipywidgets with pip or conda:
15+
Install the current version of ipywidgets using pip or conda:
1016

1117
pip install ipywidgets
12-
# or
18+
19+
or
20+
1321
conda install ipywidgets
1422

1523

@@ -26,8 +34,8 @@ To install ipywidgets from git, you will need [npm](https://www.npmjs.com/).
2634

2735
pip install -v -e .
2836

29-
Note: You need to have npm installed. The installation process will
30-
complain if you don't. If you install using sudo, you need to make sure
37+
Note: You need to have npm installed. The installation process will
38+
complain if you don't. If you install using sudo, you need to make sure
3139
that npm is also available in the PATH used with sudo.
3240

3341

@@ -41,4 +49,16 @@ To run the Javascript tests:
4149

4250
npm run test
4351

44-
This will run the test suit using `karma` with 'debug' level logging.
52+
This will run the test suite using `karma` with 'debug' level logging.
53+
54+
## Resources
55+
### ipywidgets
56+
- [Demo notebook of interactive widgets](https://github.com/ipython/ipywidgets/blob/master/examples/notebooks/Index.ipynb)
57+
- [Documentation for ipywidgets](http://ipywidgets.readthedocs.org/en/latest/) [[PDF](https://media.readthedocs.org/pdf/ipywidgets/latest/ipywidgets.pdf)]
58+
- [Issues](https://github.com/ipython/ipywidgets/issues)
59+
- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)
60+
61+
### Project Jupyter
62+
- [Project Jupyter website](https://jupyter.org)
63+
- [Online Demo of Jupyter Notebook at try.jupyter.org](https://try.jupyter.org)
64+
- [Documentation for Project Jupyter](http://jupyter.readthedocs.org/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]

0 commit comments

Comments
 (0)