From 056abdb6790da9a144da383c25b3f1beda9e3f3b Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Mon, 5 Jan 2026 17:52:51 +0100 Subject: [PATCH 1/2] Better `README` --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a8a751b..1fa2ec3 100644 --- a/README.md +++ b/README.md @@ -85,18 +85,31 @@ The **OpenPAYGO Python library** supports the following features: - Implements token generation and decoding with full support for the v2.3 of the [OpenPAYGO Token](https://github.com/EnAccess/OpenPAYGO-Token) specifications. - 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. -## Installing the library +## Installing the OpenPAYGO Python library ### Released version from PyPI -You can install `OpenPAYGO-python` from [PyPI](https://pypi.org/project/openpaygo/). -For example by running `pip install openpaygo` or adding `openpaygo` as a dependency (`uv add openpaygo`). +The easiest and recommended way to install the OpenPAYGO Python library is via [PyPI](https://pypi.org/project/openpaygo/). + +You can install it directly using a package manager, for example: + +- By adding openpaygo to your project dependencies, via: + + ```sh + uv add openpaygo + ``` + +- Or via `pip` + + ```sh + pip install openpaygo + ``` ### Development setup - Install [`uv`](https://docs.astral.sh/uv/) -- Run `uv install` -- Run `uv tests` +- Run `uv sync` +- Run `uv run pytest` ## Getting Started - OpenPAYGO Token From 0dd30b036e2cf2240a5076ccaf10c0055ecbf172 Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Mon, 5 Jan 2026 17:54:10 +0100 Subject: [PATCH 2/2] Fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1fa2ec3..b04d450 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ The **OpenPAYGO Python library** supports the following features: ## Table of Contents - [Key Features](#key-features) -- [Installing the library](#installing-the-library) +- [Installing the library](#installing-the-openpaygo-python-library) - [Getting Started - OpenPAYGO Token](#getting-started---openpaygo-token) - [Generating Tokens (Server Side)](#generating-tokens-server-side) - [Decoding Tokens (Device Side)](#decoding-tokens-device-side)