Skip to content

Commit 28f142f

Browse files
committed
update readme to explain versioning
1 parent 5502b66 commit 28f142f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,20 @@ You can find the installation documentation for the
2121
The documentation for advanced usage of Jupyter notebook can be found
2222
[here](https://jupyter-server.readthedocs.io/en/latest/).
2323

24-
For a local installation, make sure you have
24+
To install the latest release locally, make sure you have
2525
[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
2626

2727
$ pip install jupyter_server
2828

29+
If Jupyter Server is a dependency of your project/application, it is important that you pin it to a version that works for your application. Currently, Jupyter Server only has minor releases and patch releases. Minor release may include API-breaking changes while patch release will never break API.
30+
31+
* [0.2.x](https://github.com/jupyter/jupyter_server/tree/0.2.x): Extension Application API added.
32+
* [0.3.x](https://github.com/jupyter/jupyter_server/tree/master) (master): Kernels API changed. Kernel Providers are the new way to interface with kernels.
33+
34+
To install the latest patch release of a given version:
35+
36+
$ pip intall jupyter_server>=0.2
37+
2938
## Usage - Running Jupyter Server
3039

3140
### Running in a local installation

0 commit comments

Comments
 (0)