Skip to content

Commit bc87118

Browse files
committed
README: add PyPI/release badges and install instructions
1 parent 6a6967f commit bc87118

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
l9format python
22
===================
33

4+
[![PyPI](https://img.shields.io/pypi/v/l9format)](https://pypi.org/project/l9format/)
5+
[![GitHub Release](https://img.shields.io/github/v/release/LeakIX/l9format-python)](https://github.com/LeakIX/l9format-python/releases/latest)
6+
47
l9format is a schema declaration targeted at interoperability between network
58
recon tools used at LeakIX.
69

@@ -43,9 +46,19 @@ poetry run ruff check .
4346

4447
## Install
4548

46-
See [releases](https://github.com/LeakIX/l9format-python/releases/) for the
47-
different versions.
48-
The release `1.3.1-0` will be mapped to `1.3.1.post0`.
49+
```bash
50+
pip install l9format
51+
```
52+
53+
Or with a specific version:
54+
55+
```bash
56+
pip install l9format==1.4.0
57+
```
58+
59+
See [PyPI](https://pypi.org/project/l9format/) and
60+
[GitHub releases](https://github.com/LeakIX/l9format-python/releases/latest)
61+
for all available versions.
4962

5063
## Documentation
5164

0 commit comments

Comments
 (0)