diff --git a/README.md b/README.md index 533fe4a..88cd647 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,13 @@ [![PyPI Version](https://img.shields.io/pypi/v/sortbikenet?color=10d249)](https://pypi.org/project/SortBikeNet/) [![Mastodon Follow](https://img.shields.io/mastodon/follow/116693348622375119?domain=https%3A%2F%2Ffosstodon.org)](https://fosstodon.org/@BikeNetKit) +The Python package `sortbikenet` sorts links in a bike network plan for the best build order, to cover the city fast and with direct routes. + > [!CAUTION] > SortBikeNet is currently in Alpha: It is under heavy development and *not* stable enough to use yet, likely to contain breaking bugs. Breaking changes may be added anytime. +[![Example Paris](https://github.com/BikeNetKit/SortBikeNet/raw/main/docs/source/_static/sortbikenet_animated.gif)](https://bikenetkit.org/sortbikenet/paris_fr) + ## Installation ``` diff --git a/docs/source/_static/sortbikenet_animated.gif b/docs/source/_static/sortbikenet_animated.gif new file mode 100644 index 0000000..9c3e605 Binary files /dev/null and b/docs/source/_static/sortbikenet_animated.gif differ