Skip to content

Commit

Permalink
Update README (#2)
Browse files Browse the repository at this point in the history
* Align icon with text

* Automatic application of license header

* Remove _version.py

* Add binder link

* Fix binder link

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
brichet and github-actions[bot] authored Nov 14, 2024
1 parent 9d21620 commit 7bc251f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# jupyterlab_ws_chat

[![Github Actions Status](https://github.com/brichet/jupyterlab-ws-chat/workflows/Build/badge.svg)](https://github.com/brichet/jupyterlab-ws-chat/actions/workflows/build.yml)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/brichet/jupyterlab-ws-chat/HEAD?urlpath=lab)

A chat extension for Jupyterlab, based on websocket for exchanging messages.

Expand Down Expand Up @@ -39,7 +40,7 @@ message.
### Open the chat

The chat can be opened from the left panel
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/a66480412b4cb8c7b2c415afca06b24c98dbf55f/packages/jupyter-chat/style/icons/chat.svg width=24px>.
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/a66480412b4cb8c7b2c415afca06b24c98dbf55f/packages/jupyter-chat/style/icons/chat.svg width=24px style='vertical-align: middle;'>.

### Notifications and navigation

Expand All @@ -56,17 +57,17 @@ When code is inserted in a message, a toolbar is displayed under the code sectio
options must be set up from the [settings](#chat-settings)).

From this toolbar, the code can be copied to the clipboard:
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-copy.png width=24px>
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-copy.png width=24px style='vertical-align: middle;'>

If a notebook is opened and visible (and has an active cell), other actions are
available:

- copy the code to a new cell above the active one:
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-above.png width=24px>
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-above.png width=24px style='vertical-align: middle;'>
- copy the the code to a new cell below the active one:
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-below.png width=24px>
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-below.png width=24px style='vertical-align: middle;'>
- replace the content of the active cell with the code:
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-replace.png width=24px>
<img src=https://raw.githubusercontent.com/jupyterlab/jupyter-chat/refs/heads/main/docs/source/_static/images/code-toolbar-replace.png width=24px style='vertical-align: middle;'>

### Chat settings

Expand Down
4 changes: 0 additions & 4 deletions jupyterlab_ws_chat/_version.py

This file was deleted.

0 comments on commit 7bc251f

Please sign in to comment.