From 7152ade724cdb6e64f2cdbf495c8bd0e90fd9b54 Mon Sep 17 00:00:00 2001
From: Manuel-Knepper <manuel.knepper@gmx.net>
Date: Mon, 27 Jul 2026 09:57:29 +0200
Subject: [PATCH] updated README.md with basic information

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/README.md b/README.md
index c38ff4a..16ae3ec 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,56 @@
 # Bike Net Kit / Link Bike Net
+
+[![Docs](https://github.com/BikeNetKit/LinkBikeNet/actions/workflows/docs.yml/badge.svg)](https://bikenetkit.github.io/FixBikeNet/)
+[![Test](https://github.com/BikeNetKit/LinkBikeNet/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/BikeNetKit/FixBikeNet/actions/workflows/test.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/linkbikenet)](https://pypi.org/project/LinkBikeNet/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+![Human created](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/badge_humancreated.svg)
+
+The Python package `linkbikenet` finds links between the disconnected components in a city's bicycle network. 
+
+The software downloads and pre-processes data from OpenStreetMap, identifies the components and the needed links and saves the results. The source code builds on (https://github.com/nateraluis/bicycle-network-growth).
+
+
+<!--**Publication**: [https://doi.org/10.1111/gean.12324](https://doi.org/10.1111/gean.12324)-->
+
+
+## Installation
+
+### The easy way
+
+The currently default way to install LinkBikeNet is using pip:
+
+```
+pip install linkbikenet
+```
+
+<!-- > [!IMPORTANT]  
+> As of 2026-07-27, the conda-forge installation is not yet working. We will remove this note once it works.
+
+The best way to install LinkBikeNet is using [`conda`](https://docs.conda.io/projects/conda/en/latest/index.html) and the `conda-forge` channel:
+
+```
+conda install -c conda-forge linkbikenet
+``` -->
+
+<!--If this does not work, consult our [installation docs](https://bikenetkit.github.io/FixBikeNet/installation/).
+
+### Advanced and development installations
+ See our [installation docs](https://bikenetkit.github.io/FixBikeNet/installation/) for details.
+
+## Usage
+
+We provide a minimum working example in two formats:
+
+- Python script ([examples/mwe.py](examples/mwe.py))
+- Jupyter notebook ([examples/mwe.ipynb](examples/mwe.ipynb))
+
+## Docs
+Find more information in our docs: [https://bikenetkit.github.io/FixBikeNet/](https://bikenetkit.github.io/FixBikeNet/)
+-->
+
+## Supported by
+Development of BikeNetKit/LinkBikeNet was supported by the [Innovation Fund Denmark](https://innovationsfonden.dk/en) and the EU HORIZON project [JUST STREETS](https://www.just-streets.eu).
+
+
+[![Innovation Fund Denmark](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_innovationfund.png)](https://innovationsfonden.dk/en) &emsp;&emsp; [![European Union](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_eu.png)](https://commission.europa.eu/index_en) &ensp; [![JUST STREETS](https://raw.githubusercontent.com/BikeNetKit/.github/refs/heads/main/profile/_static/logo_juststreets.png)](https://www.just-streets.eu/)