Skip to content

Commit

Permalink
update readme with pypi links
Browse files Browse the repository at this point in the history
  • Loading branch information
lobis committed Feb 21, 2024
1 parent 942265f commit 6ff6a38
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

- name: Install the package with pip
- name: Install 📦 with pip
run: python -m pip install .[test]
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
- name: Install 📦
run: python -m pip install .

- name: Print package version
- name: Print 📦 version
run:
python -c "import vsr53; print('vsr53 version:', vsr53.__version__)"

Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# [VSR53](https://github.com/lobis/vsr53)

[![PyPI version](https://badge.fury.io/py/vsr53.svg)](https://badge.fury.io/py/vsr53)

[![Build and Test](https://github.com/lobis/vsr53/actions/workflows/build.yaml/badge.svg)](https://github.com/lobis/vsr53/actions/workflows/build.yaml)

This is a Python library to communicate with
Expand All @@ -18,6 +20,9 @@ default value (to 9600 instead of 115200) it works perfectly.

## Installation

This library is [available in PyPI](https://pypi.org/project/vsr53/) and can be
installed with pip:

```bash
pip install vsr53
```
Expand All @@ -27,7 +32,7 @@ pip install vsr53
```python
from vsr53 import VSR53USB

port = "/dev/ttyUSB0" # replace with the device port of your gauge
port = "/dev/ttyUSB0" # replace with the device port of your gauge
with VSR53USB(port) as gauge:
print(gauge.get_device_type())
print(gauge.get_product_name())
Expand Down

0 comments on commit 6ff6a38

Please sign in to comment.