From 1f94adef99d0e4a49f143a42195e2e3d4d519c59 Mon Sep 17 00:00:00 2001 From: Daniel Iulian Iacob Date: Wed, 7 Oct 2026 18:45:39 +0300 Subject: [PATCH 1/2] Add Installation, Guides, and License sections to README --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/README.md b/README.md index dc21f174e..b30b11fed 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,43 @@ Zen instruments the following AI SDKs to track which models are used and how man Zen is compatible with Python 3.8-3.14 and can run on Windows, Linux, and Mac OS X. +## Installation + +We recommend testing Zen locally or on staging before deploying to production. + +```sh +pip install aikido_zen +``` + +Using Poetry: + +```sh +poetry add aikido_zen +``` + +Using uv: + +```sh +uv add aikido_zen +``` + +For framework-specific instructions, check out our docs: + +- [Django](docs/django.md) +- [Flask](docs/flask.md) +- [Gunicorn](docs/gunicorn.md) +- [Quart](docs/quart.md) +- [Starlette](docs/starlette.md) +- [FastAPI](docs/fastapi.md) + +## Guides + +- [Troubleshooting](docs/troubleshooting.md) — common issues and how to debug Zen +- [Set the current user](docs/user.md) — identify users for rate limiting, blocking, and attack reports +- [Proxy / IP headers](docs/proxy.md) — configure client IP detection behind load balancers +- [Logging](docs/logging.md) — enable debug logging +- [Background process](docs/background_process.md) — how Zen's background process communicates over IPC + ## Reporting to your Aikido Security dashboard > Aikido is your no nonsense application security platform. One central system that scans your source code & cloud, shows you what vulnerabilities matter, and how to fix them - fast. So you can get back to building. @@ -100,6 +137,17 @@ See [Reporting to Aikido](#reporting-to-your-aikido-security-dashboard) to learn [Configure Zen using environment variables for authentication, mode settings, debugging, and more.](https://help.aikido.dev/doc/configuration-via-env-vars/docrSItUkeR9) +## License + +This program is offered under a commercial and under the AGPL license. +You can be released from the requirements of the AGPL license by purchasing +a commercial license. Buying such a license is mandatory as soon as you +develop commercial activities involving the Zen software without +disclosing the source code of your own applications. + +For more information, please contact Aikido Security at this +address: support@aikido.dev or create an account at https://app.aikido.dev. + ## Benchmarks The following table summarizes the performance of both a typical SQL Query and a typical NoSQL Query with and without the Zen, measured in milliseconds : | Operation | Avg. time w/o Zen | Avg. time w/ Zen | Delta | Delta in % | From f646d8ee04e45c630cca988e7249e95a45fdaeba Mon Sep 17 00:00:00 2001 From: Daniel Iulian Iacob Date: Thu, 8 Oct 2026 16:05:40 +0300 Subject: [PATCH 2/2] Simplify install commands, link track docs, drop stale benchmarks --- README.md | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b30b11fed..a99fd7703 100644 --- a/README.md +++ b/README.md @@ -72,17 +72,9 @@ We recommend testing Zen locally or on staging before deploying to production. ```sh pip install aikido_zen -``` - -Using Poetry: - -```sh +# or poetry add aikido_zen -``` - -Using uv: - -```sh +# or uv add aikido_zen ``` @@ -99,6 +91,7 @@ For framework-specific instructions, check out our docs: - [Troubleshooting](docs/troubleshooting.md) — common issues and how to debug Zen - [Set the current user](docs/user.md) — identify users for rate limiting, blocking, and attack reports +- [Track custom events](docs/track.md) — trigger events that Playbooks can act on - [Proxy / IP headers](docs/proxy.md) — configure client IP detection behind load balancers - [Logging](docs/logging.md) — enable debug logging - [Background process](docs/background_process.md) — how Zen's background process communicates over IPC @@ -148,14 +141,11 @@ disclosing the source code of your own applications. For more information, please contact Aikido Security at this address: support@aikido.dev or create an account at https://app.aikido.dev. -## Benchmarks -The following table summarizes the performance of both a typical SQL Query and a typical NoSQL Query with and without the Zen, measured in milliseconds : -| Operation | Avg. time w/o Zen | Avg. time w/ Zen | Delta | Delta in % | -| --------- | ---------------------- | --------------------- | ----- | ---------- | -| SQL Query | 1.222 ms | 1.257 ms | +0.035 ms | +3% | -| NoSQL Query | 1.090 ms | 1.110 ms | +0.020 ms | +2% | +## Benchmarks + +We run a benchmark on every commit to ensure Zen has a minimal impact on your application's performance. -See [benchmarks](benchmarks/) folder for more. +See [benchmarks](benchmarks/) ## Bug bounty program