docs: add link gen. screenshot, update example gif

jupyterhub · Dec 18, 2021 · 8f55cae · 8f55cae
1 parent 9f380a9
commit 8f55cae
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,14 @@ information.
 pip install nbgitpuller
 ```
 
-## Example
+## Example use
 
-![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/v0.8.0/docs/_static/nbpuller.gif)
+1. The [nbgitpuller link
+   generator](https://jupyterhub.github.io/nbgitpuller/link) is used to create a
+   link.
+
+   ![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/9f380a933335f0f069b6e2f9965ed78c3abcce7a/docs/_static/nbgitpuller-link-generator.png)
+
+2. The link is clicked.
+
+   ![](https://raw.githubusercontent.com/jupyterhub/nbgitpuller/9f380a933335f0f069b6e2f9965ed78c3abcce7a/docs/_static/nbgitpuller-demo.gif)
diff --git a/docs/index.md b/docs/index.md
@@ -8,10 +8,19 @@ or other version control machinery.
 by using `git` under the hood.
 It is commonly used to distribute content to multiple users of a JupyterHub, though it works just fine on an individual person's computer, if they have Jupyter installed.
 
-Here's an example of `nbgitpuller` in action:
+Here's an example of using `nbgitpuller`:
 
-```{image} _static/nbpuller.gif
-```
+1. The [nbgitpuller link
+   generator](https://jupyterhub.github.io/nbgitpuller/link) is used to create a
+   link.
+
+   ```{image} _static/nbgitpuller-link-generator.png
+   ```
+
+2. The link is clicked.
+
+   ```{image} _static/nbgitpuller-demo.gif
+   ```
 
 ## Use `nbgitpuller`