Update README
All checks were successful
/ test (push) Successful in 4s

This commit is contained in:
phil 2024-12-01 06:03:11 +01:00
parent e72f65ab8f
commit c388823883

View file

@ -1,10 +1,14 @@
## Installation
Use `uv` (<https://docs.astral.sh/uv/getting-started/installation>).
Easy way to install `uv` on Debian:
```sh
PIP_EXTRA_INDEX_URL=https://pypi.org/simple/ pip install --index-url https://philo.ydns.eu/code/api/packages/Philome/pypi/simple/ sms-handler
```
Debian and other systems require using `pipx` `pip`:
```sh
apt install -y pipx && pipx install uv
sudo apt install -y pipx
PIP_EXTRA_INDEX_URL=https://pypi.org/simple/ pipx install --index-url https://philo.ydns.eu/code/api/packages/Philome/pypi/simple/ sms-handler
```
## Configuration
@ -69,7 +73,7 @@ Use `podman` or `docker`:
podman run tiptop:5000/sms_handler
```
**Note**: the container is not published publicly yet.
**Note**: the container is not published publicly yet!
Pass parameters like this: