Skip to content

Commit 69aa788

Browse files
committed
Merge mwakaba2/jupyterlab-notifications:main
Merge the next url commit manually in order to avoid merge conflict. 50f3602
2 parents ecc5e8f + 3898b23 commit 69aa788

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
@@ -33,19 +33,14 @@ In the `tutorial` directory, there are several example notebooks you can use to
3333
* Notebooks with `py3_demo_` prefix - Minimal Python3 Notebooks to test out the extension.
3434
* `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.
3535

36-
## Requirements 🧰
36+
## Compatible Versions and Requirements 🧰
3737

38-
* Web Browser that supports the Notification Web API (See [Browser Compatibility Chart](https://developer.mozilla.org/en-US/docs/Web/API/notification#browser_compatibility))
39-
* JupyterLab >= 3.0
40-
* :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:
41-
```json5
42-
{
43-
// Recording timing
44-
// Should timing data be recorded in cell metadata
45-
"recordTiming": true
46-
}
47-
```
48-
* The cell timing doesn't need to be enabled for Jupyterlab >= 3.1 and Jupyterlab notification version >= v0.3.0.
38+
| `jupyterlab-notifications` | `jupyterlab` | `Notebook Cell Timing Enabled` | `Browser Requirements` |
39+
|--------------------------- |---------------| -------------------------------| ---------------------- |
40+
| `>=0.3.0` | `>=3.1.0` | Not required | Supports the Notification Web API*
41+
| `<0.3.0` | `>3.0.0` | Required | Supports the Notification Web API* |
42+
43+
*For Notification Web API support, please check out [Browser Compatibility Chart](https://developer.mozilla.org/en-US/docs/Web/API/notification#browser_compatibility))
4944

5045
## Install
5146

@@ -108,6 +103,19 @@ Use the following settings to update cell execution time for a notification and
108103

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

106+
### How to enable Notebook Cell Timing
107+
108+
: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:
109+
```json5
110+
{
111+
// Recording timing
112+
// Should timing data be recorded in cell metadata
113+
"recordTiming": true
114+
}
115+
```
116+
117+
The cell timing doesn't need to be enabled for Jupyterlab >= 3.1 and Jupyterlab notification version >= v0.3.0.
118+
111119
## (Optional) Notifications using `ntfy`
112120

113121
You can recieve notifications via `ntfy`.

0 commit comments

Comments
 (0)