Skip to content

Commit 0e9338e

Browse files
authored
Include demo and tutorials section
1 parent e5590bf commit 0e9338e

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,16 @@
1919

2020
<img width="394" alt="Screen Shot 2021-07-31 at 12 49 49 PM" src="https://user-images.githubusercontent.com/3497137/127746862-79012afd-caa7-4319-930d-7acfc74fa2f4.png">
2121

22+
## Quick demos and tutorials :notebook:
2223

23-
## Requirements
24+
To test out this extension without any local set-up, please check out the [binder link](https://mybinder.org/v2/gh/mwakaba2/jupyterlab-notifications/main?urlpath=lab/tree/tutorial/py3_demo.ipynb). This will set-up the environment, install the extension, and take you to several demo notebooks for you to play around with to get familiar with the notifications extension.
25+
26+
In the `tutorial` directory, there are several example notebooks you can use to test out the notifications extension.
27+
28+
* Notebooks with `py3_demo_` prefix - Minimal Python3 Notebooks to test out the extension.
29+
* `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.
30+
31+
## Requirements 🧰
2432

2533
* Web Browser that supports the Notification Web API (See [Browser Compatibility Chart](https://developer.mozilla.org/en-US/docs/Web/API/notification#browser_compatibility))
2634
* JupyterLab >= 3.0

0 commit comments

Comments
 (0)