Skip to content

Commit 373b55c

Browse files
authored
Better README (#32)
* Better `README` * Fix link
1 parent 1dbdd15 commit 373b55c

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The **OpenPAYGO Python library** supports the following features:
7272
## Table of Contents
7373

7474
- [Key Features](#key-features)
75-
- [Installing the library](#installing-the-library)
75+
- [Installing the library](#installing-the-openpaygo-python-library)
7676
- [Getting Started - OpenPAYGO Token](#getting-started---openpaygo-token)
7777
- [Generating Tokens (Server Side)](#generating-tokens-server-side)
7878
- [Decoding Tokens (Device Side)](#decoding-tokens-device-side)
@@ -85,18 +85,31 @@ The **OpenPAYGO Python library** supports the following features:
8585
- Implements token generation and decoding with full support for the v2.3 of the [OpenPAYGO Token](https://github.com/EnAccess/OpenPAYGO-Token) specifications.
8686
- Implements payload authentication (verification + signing) and conversion from simple to condensed payload (and back) with full support of the v1.0-rc1 of the [OpenPAYGO Metrics](https://github.com/openpaygo/metrics) specifications.
8787

88-
## Installing the library
88+
## Installing the OpenPAYGO Python library
8989

9090
### Released version from PyPI
9191

92-
You can install `OpenPAYGO-python` from [PyPI](https://pypi.org/project/openpaygo/).
93-
For example by running `pip install openpaygo` or adding `openpaygo` as a dependency (`uv add openpaygo`).
92+
The easiest and recommended way to install the OpenPAYGO Python library is via [PyPI](https://pypi.org/project/openpaygo/).
93+
94+
You can install it directly using a package manager, for example:
95+
96+
- By adding openpaygo to your project dependencies, via:
97+
98+
```sh
99+
uv add openpaygo
100+
```
101+
102+
- Or via `pip`
103+
104+
```sh
105+
pip install openpaygo
106+
```
94107

95108
### Development setup
96109

97110
- Install [`uv`](https://docs.astral.sh/uv/)
98-
- Run `uv install`
99-
- Run `uv tests`
111+
- Run `uv sync`
112+
- Run `uv run pytest`
100113

101114
## Getting Started - OpenPAYGO Token
102115

0 commit comments

Comments
 (0)