Skip to content

Commit 933529d

Browse files
committed
README.md
1 parent 270995b commit 933529d

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Jupyter Offline Notebook
33

44
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/manics/jupyter-offlinenotebook/master?filepath=example.ipynb)
55

6-
Save and load notebooks to local-storage, even if you've lost your connection to the server.
6+
Save and load notebooks to browser storage, even if you've lost your connection to the server.
77

88

99
Installation
@@ -66,3 +66,12 @@ There are [several major limitations](https://github.com/manics/jupyter-offlinen
6666
- Local-storage is limited by quotas imposed by the browser.
6767
- A repository ID and path of the notebook within Jupyter Notebook are used, joined by a ` `.
6868
This may change in future.
69+
70+
71+
Development notes
72+
-----------------
73+
74+
This extension stores notebooks in browser storage using the [IndexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API), wrapped with [Dexie.js](https://dexie.org/).
75+
76+
One server API call is made during initialisation to obtain the storage configuration.
77+
Everything else is done client-side so should work even if the server is disconnected.

0 commit comments

Comments
 (0)