Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
timtreis committed Jun 27, 2023
1 parent cdd340c commit a87fa07
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

[![Tests][badge-tests]][link-tests]
[![Documentation][badge-docs]][link-docs]
[![Documentation][badge-pypi]][link-pypi]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/timtreis/gefslim/test.yaml?branch=main
[link-tests]: https://github.com/timtreis/gefslim/actions/workflows/test.yml
[badge-docs]: https://img.shields.io/readthedocs/gefslim
[badge-pypi]: https://badge.fury.io/py/gefslim.svg

A minimal reader for .gef files

Expand Down Expand Up @@ -36,8 +38,15 @@ pip install gefslim
pip install git+https://github.com/timtreis/gefslim.git@main
```

2. Install from PyPI:

```bash
pip install gefslim
```

[scverse-discourse]: https://discourse.scverse.org/
[issue-tracker]: https://github.com/timtreis/gefslim/issues
[changelog]: https://gefslim.readthedocs.io/latest/changelog.html
[link-docs]: https://gefslim.readthedocs.io
[link-api]: https://gefslim.readthedocs.io/latest/api.html
[link-api]: https://gefslim.readthedocs.io/en/latest/generated/gefslim.GEF.html
[link-pypi]: https://pypi.org/project/gefslim/

0 comments on commit a87fa07

Please sign in to comment.