readme

README.md

@@ -1,7 +1,11 @@
-# jupyterlab_gist_it
+# Gist It!
 
 [![Github Actions Status](https://github.com/adrn/jupyterlab-gist-it/workflows/Build/badge.svg)](https://github.com/adrn/jupyterlab-gist-it/actions/workflows/build.yml)
-Upload Jupyter notebooks to GitHub Gist.
+
+Upload a Jupyter notebook as a [Gist](https://gist.github.com/) with the click of a
+button. This is a Jupyterlab v4.0 compatible version of the original Jupyter notebook
+extension [Gist
+it](https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/gist_it/readme.html).
 
 ## Requirements
 
@@ -44,7 +48,9 @@ jupyter labextension develop . --overwrite
 jlpm build
 ```
 
-You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+You can watch the source directory and run JupyterLab at the same time in different
+terminals to watch for changes in the extension's source and automatically rebuild the
+extension.
 
 ```bash
 # Watch the source directory in one terminal, automatically rebuilding when needed
@@ -53,9 +59,13 @@ jlpm watch
 jupyter lab
 ```
 
-With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+With the watch command running, every saved change will immediately be built locally and
+available in your running JupyterLab. Refresh JupyterLab to load the change in your
+browser (you may need to wait several seconds for the extension to be rebuilt).
 
-By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+By default, the `jlpm build` command generates the source maps for this extension to
+make it easier to debug using the browser dev tools. To also generate source maps for
+the JupyterLab core extensions, you can run the following command:
 
 ```bash
 jupyter lab build --minimize=False
@@ -67,9 +77,10 @@ jupyter lab build --minimize=False
 pip uninstall jupyterlab_gist_it
 ```
 
-In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
-command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
-folder is located. Then you can remove the symlink named `jupyterlab_gist_it` within that folder.
+In development mode, you will also need to remove the symlink created by `jupyter
+labextension develop` command. To find its location, you can run `jupyter labextension
+list` to figure out where the `labextensions` folder is located. Then you can remove the
+symlink named `jupyterlab_gist_it` within that folder.
 
 ### Testing the extension
 
@@ -86,8 +97,10 @@ jlpm test
 
 #### Integration tests
 
-This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
-More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration
+tests (aka user level tests). More precisely, the JupyterLab helper
+[Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle
+testing the extension in JupyterLab.
 
 More information are provided within the [ui-tests](./ui-tests/README.md) README.