From fff5b4f36621426d0168b54259557a07131a8f39 Mon Sep 17 00:00:00 2001 From: jzonthemtn Date: Sat, 14 Sep 2024 18:42:58 -0400 Subject: [PATCH] Updating the readme. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f3cdfab..d04fa24 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,11 @@ Philter is available on the cloud marketplaces as a turnkey redaction solution. AI models for identifying PII and PHI in text are available at https://github.com/philterd/pii-models. These models can be used by both Phileas and [Philter](https://github.com/philterd/philter). -## Quick Start +## Running Philter -Philter can be run using `docker compose` after building: +To launch Philter, use the `docker-compose.yml`: ``` -mvn clean install -docker compose build docker compose up ``` @@ -34,6 +32,14 @@ Once the containers are running, you can submit text to Philter's API for redact curl -k "https://localhost:8080/api/filter" --data "George Washington lives in 90210 and his SSN was 123-45-6789." -H "Content-type: text/plain" ``` +## Build Philter + +Philter is built with Maven: + +``` +mvn clean install +``` + ## License As of Philter 2.6.0, Philter is licensed under the Apache License, version 2.0. Previous versions were under a proprietary license.