Skip to content

Commit 701b3ea

Browse files
committed
more badging, update js README
1 parent edc85ea commit 701b3ea

File tree

3 files changed

+62
-13
lines changed

3 files changed

+62
-13
lines changed

Diff for: CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ A full development environment will require:
1616
- `jupyterlab >=3`
1717
- once built, `jupyterlab` version `1` or `2` may be used
1818
- `nodejs >=12` e.g. via
19-
```bash
20-
conda install -c conda-forge 'nodejs>=12'
21-
```
19+
```bash
20+
conda install -c conda-forge 'nodejs>=12'
21+
```
2222

2323
## Development Tasks
2424

Diff for: README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,28 @@
33
[![Interactive demo on Binder][binder-badge]][binder]
44
[![Install from PyPI][pypi-badge]][pypi]
55
[![Install from conda-forge][cf-badge]][cf]
6+
[![Reuse from npm][npm-badge]][npm]
67
[![Documentation Status][docs-badge]][docs]
78
[![Build Status][ci-badge]][ci]
89

910
A Python / ThreeJS bridge for [Jupyter Widgets][widgets].
1011

12+
![Screencast]
13+
1114
[binder-badge]: https://mybinder.org/badge_logo.svg
1215
[binder]: https://mybinder.org/v2/gh/jupyter-widgets/pythreejs/HEAD?urlpath=lab%2Ftree%2Fexamples%2FExamples.ipynb
1316
[pypi-badge]: https://img.shields.io/pypi/v/pythreejs?logo=pypi
1417
[pypi]: https://pypi.org/project/pythreejs
1518
[cf-badge]: https://img.shields.io/conda/vn/conda-forge/pythreejs?logo=conda-forge
1619
[cf]: https://anaconda.org/conda-forge/pythreejs
20+
[npm-badge]: https://img.shields.io/npm/v/jupyter-threejs?logo=npm
21+
[npm]: https://www.npmjs.com/package/jupyter-threejs
1722
[docs-badge]: https://readthedocs.org/projects/pythreejs/badge/?version=stable
1823
[docs]: https://pythreejs.readthedocs.io/en/stable
1924
[ci-badge]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml/badge.svg
2025
[ci]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml?query=branch%3Amaster
2126
[widgets]: https://jupyter.org/widgets
22-
23-
![Screencast](screencast.gif)
27+
[screencast]: https://raw.githubusercontent.com/jupyter-widgets/pythreejs/master/screencast.gif
2428

2529
## Installation
2630

Diff for: js/README.md

+53-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,62 @@
1-
Jupyter ThreeJS Widget
2-
======================
1+
# Jupyter ThreeJS Widget
32

4-
Interactive Threejs widget for the Jupyter notebook
3+
[![Interactive demo on Binder][binder-badge]][binder]
4+
[![Install from PyPI][pypi-badge]][pypi]
5+
[![Install from conda-forge][cf-badge]][cf]
6+
[![Reuse from npm][npm-badge]][npm]
7+
[![Documentation Status][docs-badge]][docs]
8+
[![Build Status][ci-badge]][ci]
9+
10+
Interactive ThreeJS widgets for the Jupyter Notebook Classic and JupyterLab
11+
12+
![Screencast]
13+
14+
[binder-badge]: https://mybinder.org/badge_logo.svg
15+
[binder]: https://mybinder.org/v2/gh/jupyter-widgets/pythreejs/HEAD?urlpath=lab%2Ftree%2Fexamples%2FExamples.ipynb
16+
[pypi-badge]: https://img.shields.io/pypi/v/pythreejs?logo=pypi
17+
[pypi]: https://pypi.org/project/pythreejs
18+
[cf-badge]: https://img.shields.io/conda/vn/conda-forge/pythreejs?logo=conda-forge
19+
[cf]: https://anaconda.org/conda-forge/pythreejs
20+
[npm-badge]: https://img.shields.io/npm/v/jupyter-threejs?logo=npm
21+
[npm]: https://www.npmjs.com/package/jupyter-threejs
22+
[docs-badge]: https://readthedocs.org/projects/pythreejs/badge/?version=stable
23+
[docs]: https://pythreejs.readthedocs.io/en/stable
24+
[ci-badge]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml/badge.svg
25+
[ci]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml?query=branch%3Amaster
26+
[widgets]: https://jupyter.org/widgets
27+
[screencast]: https://raw.githubusercontent.com/jupyter-widgets/pythreejs/master/screencast.gif
528

629
The reference Python backend, `pythreejs` is available
7-
[here](https://github.com/jupyter-widgets/pythreejs), with examples.
30+
[here](https://github.com/jupyter-widgets/pythreejs), with examples. Install it
31+
with:
832

9-
Package Install
10-
---------------
33+
```bash
34+
pip install pythreejs
35+
```
1136

12-
**Prerequisites**
13-
- [node](http://nodejs.org/)
37+
or
38+
39+
```bash
40+
conda install -c conda-forge pythreejs
41+
```
42+
43+
## Development Install
44+
45+
### Prerequisites
46+
47+
- [nodejs](http://nodejs.org/)
1448

1549
```bash
1650
npm install --save jupyter-threejs
1751
```
52+
53+
`yarn`, or the JupyterLab-bundled version `jlpm`, may be also be used.
54+
55+
```bash
56+
yarn add jupyter-threejs
57+
jlpm add jupyter-threejs
58+
```
59+
60+
For more information, see the [contributing guide][contributing].
61+
62+
[contributing]: https://github.com/jupyter-widgets/pythreejs/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)