Skip to content

Commit f6a1152

Browse files
committed
improve readme with gifs, add conda installation instructions
Signed-off-by: Itay Dafna <[email protected]>
1 parent d8c4ea7 commit f6a1152

File tree

6 files changed

+25
-6
lines changed

6 files changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,33 @@ Fast Datagrid widget for the Jupyter Notebook and JupyterLab
99

1010
## Menu
1111

12+
- [Usage and Examples](#Usage-and-Examples)
1213
- [Installation](#Installation)
1314
- [Development installation](#Development-installation)
14-
- [Usage and Examples](#Usage-and-Examples)
1515
- [Contributions](#Contributions)
1616
- [License](#License)
1717
- [Code of Conduct](#Code-of-Conduct)
1818
- [Security Vulnerability reporting](#Security-Vulnerability-reporting)
1919

20+
## Usage and Examples
21+
22+
A fully-featured DataGrid interface
23+
[![DataGrid](./static/ipydatagrid_1.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)
24+
25+
Highly performant and fully integrated with ipywidgets
26+
[![DataGrid](./static/ipydatagrid_2.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)
27+
28+
Customize the way data is represented in your grid using a variety of renderers
29+
[![DataGrid](./static/ipydatagrid_3.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)
30+
31+
Enjoy a sophisticated selections model with two-way data binding
32+
[![DataGrid](./static/ipydatagrid_4.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/Selections.ipynb)
33+
34+
Conditional formatting powered by Vega Expressions
35+
[![DataGrid](./static/ipydatagrid_5.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/ConditionalFormatting.ipynb)
36+
37+
Tutorial and example notebooks can be found in the `/examples` directory.
38+
2039
## Installation
2140

2241
If using JupyterLab, `ipydatagrid` requires JupyterLab version 3 or higher.
@@ -29,7 +48,11 @@ Using `pip`:
2948
pip install ipydatagrid
3049
```
3150

32-
Using `conda`: coming soon!
51+
Using `conda`:
52+
53+
```bash
54+
conda install -c conda-forge ipydatagrid
55+
```
3356

3457
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
3558
the nbextension:
@@ -66,10 +89,6 @@ jupyter labextension develop . --overwrite
6689
Note for developers: the `--symlink` argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.
6790
`
6891

69-
## Usage and Examples
70-
71-
Tutorial and example notebooks can be found in the `/examples` directory.
72-
7392
## Contributions
7493

7594
We :heart: contributions.

static/ipydatagrid_1.gif

1.46 MB
Loading

static/ipydatagrid_2.gif

1.46 MB
Loading

static/ipydatagrid_3.gif

2.57 MB
Loading

static/ipydatagrid_4.gif

199 KB
Loading

static/ipydatagrid_5.gif

51.3 KB
Loading

0 commit comments

Comments
 (0)