Skip to content

Commit

Permalink
docs: add "back to top" links in README.md for improved navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
W. Meijer committed Nov 4, 2024
1 parent aa4da44 commit 7915c3f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
then run the following `pip install -e ".[examples]"` to install the package.

Then run an example with `python examples/main.py`
<div align="right">(<a href="#readme-top">back to top</a>)</div>

## Why?

Expand All @@ -48,6 +49,8 @@ Then run an example with `python examples/main.py`
<img src="./docs/assets/anti-entropy.gif" alt="alt text" width="450" height="whatever">
</div>

<div align="right">(<a href="#readme-top">back to top</a>)</div>

## Example

Assuming:
Expand Down Expand Up @@ -79,3 +82,5 @@ print(G.nodes(data=True))
print(G.edges(data=True))
>>> [(1, 2, {'color': 'pink'})]
```

<div align="right">(<a href="#readme-top">back to top</a>)</div>

0 comments on commit 7915c3f

Please sign in to comment.