Skip to content

Commit 50f3602

Browse files
authored
Update requirements & add compatible versions
1 parent 4a3709a commit 50f3602

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,14 @@ In the `tutorial` directory, there are several example notebooks you can use to
2929
* Notebooks with `py3_demo_` prefix - Minimal Python3 Notebooks to test out the extension.
3030
* `julia_demo.ipynb` - Minimal Julia Notebook to test out the extension. :warning: Note: The `tutorial/julia_demo.ipynb` will not work in the binder environment and will require additional set-up to test the Julia Notebook Kernel locally.
3131

32-
## Requirements 🧰
32+
## Compatible Versions and Requirements 🧰
3333

34-
* Web Browser that supports the Notification Web API (See [Browser Compatibility Chart](https://developer.mozilla.org/en-US/docs/Web/API/notification#browser_compatibility))
35-
* JupyterLab >= 3.0
36-
* :warning: For versions < `0.3.0`, Notebook Cell Timing needs to be enabled for Jupyterlab Notifications to work. Please go to Settings -> Advanced Settings Editor -> Notebook and update setting to:
37-
```json5
38-
{
39-
// Recording timing
40-
// Should timing data be recorded in cell metadata
41-
"recordTiming": true
42-
}
43-
```
44-
* The cell timing doesn't need to be enabled for Jupyterlab >= 3.1 and Jupyterlab notification version >= v0.3.0.
34+
| `jupyterlab-notifications` | `jupyterlab` | `Notebook Cell Timing Enabled` | `Browser Requirements` |
35+
|--------------------------- |---------------| -------------------------------| ---------------------- |
36+
| `>=0.3.0` | `>=3.1.0` | Not required | Supports the Notification Web API*
37+
| `<0.3.0` | `>3.0.0` | Required | Supports the Notification Web API* |
38+
39+
*For Notification Web API support, please check out [Browser Compatibility Chart](https://developer.mozilla.org/en-US/docs/Web/API/notification#browser_compatibility))
4540

4641
## Install
4742

@@ -98,6 +93,19 @@ Use the following settings to update cell execution time for a notification and
9893

9994
![notification](https://user-images.githubusercontent.com/3497137/111881088-01db5200-897d-11eb-8faa-4701cabfcde4.gif)
10095

96+
### How to enable Notebook Cell Timing
97+
98+
:warning: For versions < `0.3.0`, Notebook Cell Timing needs to be enabled for Jupyterlab Notifications to work. Please go to Settings -> Advanced Settings Editor -> Notebook and update setting to:
99+
```json5
100+
{
101+
// Recording timing
102+
// Should timing data be recorded in cell metadata
103+
"recordTiming": true
104+
}
105+
```
106+
107+
The cell timing doesn't need to be enabled for Jupyterlab >= 3.1 and Jupyterlab notification version >= v0.3.0.
108+
101109
## Contributing
102110

103111
### Development install

0 commit comments

Comments
 (0)