docs: update readme

NorskRegnesentral · Jan 4, 2025 · d19003d · d19003d
1 parent c5b6e05
commit d19003d
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# [`skchange`](https://skchange.readthedocs.io/en/latest/)
+# skchange
 
 [![codecov](https://codecov.io/gh/NorskRegnesentral/skchange/graph/badge.svg?token=QSS3AY45KY)](https://codecov.io/gh/NorskRegnesentral/skchange)
 [![tests](https://github.com/NorskRegnesentral/skchange/actions/workflows/tests.yaml/badge.svg)](https://github.com/NorskRegnesentral/skchange/actions/workflows/tests.yaml)
@@ -7,21 +7,23 @@
 [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Python](https://img.shields.io/pypi/pyversions/skchange)](https://pypi.org/project/skchange/)
 
-[`skchange`]((https://skchange.readthedocs.io/en/latest/)) provides [`sktime`](https://www.sktime.net/)-compatible change detection and changepoint-based anomaly detection algorithms.
+[skchange]((https://skchange.readthedocs.io/en/latest/)) provides [sktime](https://www.sktime.net/)-compatible change detection and changepoint-based anomaly detection algorithms.
 
 Experimental but maturing.
 
 ## Documentation
-[Docs](https://skchange.readthedocs.io/) | [Notebook tutorial](https://github.com/sktime/sktime-tutorial-pydata-global-2024)
+
+* [Documentation](https://skchange.readthedocs.io/)
+* [Notebook tutorial](https://github.com/sktime/sktime-tutorial-pydata-global-2024)
 
 
 ## Installation
-It is recommended to install skchange with [`numba`](https://numba.readthedocs.io/en/stable/) for faster performance:
+It is recommended to install skchange with [numba](https://numba.readthedocs.io/en/stable/) for faster performance:
 ```sh
 pip install skchange[numba]
 ```
 
-Alternatively, you can install `skchange` without `numba`:
+Alternatively, you can install skchange without numba:
 ```sh
 pip install skchange
 ```
@@ -73,4 +75,4 @@ detector.fit_predict(df)
 
 ## License
 
-`skchange` is a free and open-source software licensed under the [BSD 3-clause license](https://github.com/NorskRegnesentral/skchange/blob/main/LICENSE).
+skchange is a free and open-source software licensed under the [BSD 3-clause license](https://github.com/NorskRegnesentral/skchange/blob/main/LICENSE).