Skip to content

Commit fb7befd

Browse files
committed
Updated README
1 parent e9ea9a2 commit fb7befd

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
11
# notebook-snippet-manager
2-
A Jupyter Notebook extension for managing code snippets
2+
notebook-snippet-manager Jupyter Notebook extension for managing code snippets.
3+
The extension uses the browser's WebStorage API so clearing browsing data will
4+
wipe out all snippets and the amount of snippets that you can store is limited
5+
by the space limitations of your browser's WebStorage implementation. Please note
6+
that this extension is in beta, if you experience any difficulties, please submit
7+
any issue and I will do my best to address them promptly. Don't forget to star this
8+
repository so you can stay on top of the latest updates!
9+
10+
### To Dos
11+
- [ ] Explore alternatives to WebStorage
12+
- [ ] Add ability to search through snippets
13+
14+
### Installation Instructions
15+
1. Run `jupyter --config-dir` to determine the location of your Jupyter Notebook configuration
16+
2. Download `notebook-snippet-manager.js` and `list.js` and copy them to `$(jupyter --config-dir)/nbextensions`.
17+
3. Run `jupyter nbextension enable notebook-snippet-manager`.

0 commit comments

Comments
 (0)