Skip to content

Commit

Permalink
Update README installation instructions and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhad6 committed Aug 29, 2024
1 parent 2d66dc9 commit 05b3b6e
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# JupyterLab Open Warning

[![PyPI Latest Release](https://img.shields.io/pypi/v/jupyterlab-open-warning)](https://pypi.org/project/jupyterlab-open-warning/)
[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/jupyterlab-open-warning)](https://pypi.org/project/jupyterlab-open-warning/)
[![License](https://img.shields.io/pypi/l/jupyterlab-open-warning)](https://github.com/PainterQubits/jupyterlab-open-warning/blob/main/LICENSE)
[![CI](https://github.com/PainterQubits/jupyterlab-open-warning/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/jupyterlab-open-warning/actions/workflows/ci.yml)

JupyterLab extension to display a warning dialog when opening a file that another user has open.

## Installation

Install the latest version of JupyterLab Open Warning using pip:

```
pip install -U jupyterlab-open-warning --extra-index-url https://painterqubits.github.io/jupyterlab-open-warning/releases
pip install -U jupyterlab-open-warning
```

This extension should run alongside
Expand All @@ -19,7 +24,7 @@ extension.
To automatically install along with Real-Time Collaboration, use the `rtc` extra:

```
pip install -U "jupyterlab-open-warning[rtc]" --extra-index-url https://painterqubits.github.io/jupyterlab-open-warning/releases
pip install -U "jupyterlab-open-warning[rtc]"
```

While the Real-Time Collaboration extension is required in order to display open warning
Expand Down

0 comments on commit 05b3b6e

Please sign in to comment.