Skip to content

Commit b5a5f20

Browse files
authored
Add disclaimer to README.md
1 parent 4a7747f commit b5a5f20

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,22 @@
22

33
[![Github Actions Status](https://github.com/jtpio/jupyterlab-filesystem/workflows/Build/badge.svg)](https://github.com/jtpio/jupyterlab-filesystem/actions/workflows/build.yml)
44

5-
Browse local files using the Filesystem API.
5+
Browse local files using the non-standard Web Browser Filesystem API.
6+
7+
⚠️ **This extension is compatible with Chromium-based browsers only (for now)** ⚠️
8+
9+
![image](https://user-images.githubusercontent.com/591645/162558622-3cc357a6-eb7c-4147-860d-1c8973eeee29.png)
10+
11+
More info on MDN: https://developer.mozilla.org/en-US/docs/Web/API/Window/showOpenFilePicker
612

713
https://user-images.githubusercontent.com/591645/160241594-6b363b06-2103-445a-ac68-9ecc6104e0c4.mp4
814

15+
## Motivation
16+
17+
The main motivation for this extension is to give access to local files in JupyterLite: https://github.com/jupyterlite/jupyterlite/issues/403
18+
19+
It can also be used on hosted and ephemeral JupyterLab deployments such as [Binder](https://mybinder.org).
20+
921
## Requirements
1022

1123
- JupyterLab >= 3.0

0 commit comments

Comments
 (0)