Skip to content

Commit 7017ee1

Browse files
authored
Update README.md (#104)
1 parent 5ce69c4 commit 7017ee1

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,36 @@
33
[![Github Actions Status](https://github.com/jupyterlab/jupyter-chat/workflows/Build/badge.svg)](https://github.com/jupyterlab/jupyter-chat/actions/workflows/build.yml)
44
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyter-chat/main?urlpath=lab)
55

6-
This project is a monorepo containing the frontend components and extensions to build
7-
a chat in Jupyter.
6+
This project is a monorepo containing:
7+
8+
- an extension to add a chat in jupyterlab
9+
- the frontend components to build a chat extension for Jupyter application
810

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

1113
![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)
1214

13-
> **Warning**
14-
>
15+
> [!WARNING]
1516
> This project is still in early development stage and its API may change often before
1617
a stable release.
1718

19+
## Install chat extension
20+
21+
The chat extension is available on [PyPI](https://pypi.org/project/jupyterlab-chat/).
22+
23+
```bash
24+
pip install jupyterlab-chat
25+
```
26+
27+
To uninstall the package:
28+
29+
```bash
30+
pip uninstall jupyterlab-chat
31+
```
32+
33+
> [!NOTE]
34+
> The extension was released as [jupyterlab-collaborative-chat](https://pypi.org/project/jupyterlab-collaborative-chat/) until version 0.5.0.
35+
1836
## Composition
1937

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

5573
## Contributing
5674

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

0 commit comments

Comments
 (0)