diff --git a/README.md b/README.md index 421b2d0..580074b 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,12 @@ pip install -e . After this, you will have a python script `opf` that can be run directly or via `python -m opf`. The script can be used in 3 separate ways, as described below. +Alternatively, if you have [uv](https://docs.astral.sh/uv/getting-started/installation/) installed, you can install it as a single command `opf` with `uv tool install`: + +```bash +uv tool install git+https://github.com/openai/privacy-filter +``` + 2. Run one-shot redaction: By default, `opf` looks for a model at the directory pointed to by the `OPF_CHECKPOINT` variable, or `~/.opf/privacy_filter`. If a model is not found in the `~/.opf/privacy_filter` location, it will be downloaded.