Skip to content

Commit

Permalink
Update README.md (#104)
Browse files Browse the repository at this point in the history
  • Loading branch information
brichet authored Nov 22, 2024
1 parent 5ce69c4 commit 7017ee1
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,36 @@
[![Github Actions Status](https://github.com/jupyterlab/jupyter-chat/workflows/Build/badge.svg)](https://github.com/jupyterlab/jupyter-chat/actions/workflows/build.yml)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyter-chat/main?urlpath=lab)

This project is a monorepo containing the frontend components and extensions to build
a chat in Jupyter.
This project is a monorepo containing:

- an extension to add a chat in jupyterlab
- the frontend components to build a chat extension for Jupyter application

Many components of this chat project come from [jupyter-ai](https://github.com/jupyterlab/jupyter-ai).

![a screenshot showing the jupyter-chat extension used in two browser windows](https://github.com/jupyterlab/jupyter-chat/assets/591645/5dac0b00-43ed-4458-ab67-18207644b92b)

> **Warning**
>
> [!WARNING]
> This project is still in early development stage and its API may change often before
a stable release.

## Install chat extension

The chat extension is available on [PyPI](https://pypi.org/project/jupyterlab-chat/).

```bash
pip install jupyterlab-chat
```

To uninstall the package:

```bash
pip uninstall jupyterlab-chat
```

> [!NOTE]
> The extension was released as [jupyterlab-collaborative-chat](https://pypi.org/project/jupyterlab-collaborative-chat/) until version 0.5.0.
## Composition

### Typescript package
Expand Down Expand Up @@ -54,4 +72,4 @@ This extension has been moved to its own [repository](https://github.com/brichet

## Contributing

See the contributing part of each package for details.
See the contributing part of the [documentation](https://jupyter-chat.readthedocs.io/en/latest/developers/contributing/index.html).

0 comments on commit 7017ee1

Please sign in to comment.