From 6699da3d3104214d281874e05337304cf2247aeb Mon Sep 17 00:00:00 2001 From: FROWNINGdev <218313741+FROWNINGdev@users.noreply.github.com> Date: Mon, 28 Sep 2026 02:26:15 +0500 Subject: [PATCH] docs(readme): quickstart shows readable output, then the checks The first command the README hands a newcomer, 'uvx django-orm-lens scan', prints the full JSON index: about 200 lines for a five-model project, not the first insight the section promises. The quickstart now runs 'scan -f table' for an overview, then nplusone and migration-risk, which is where the tool finds something worth acting on. Same change in ru/es/zh. --- README.md | 6 ++++-- docs/i18n/README.es.md | 6 ++++-- docs/i18n/README.ru.md | 6 ++++-- docs/i18n/README.zh.md | 6 ++++-- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 596bf55..8e5b819 100644 --- a/README.md +++ b/README.md @@ -45,10 +45,12 @@ Your entire model graph — live in your editor sidebar, gating your CI, and ans ## ⚡ 10 seconds to first insight ```bash -uvx django-orm-lens scan # or: pipx run django-orm-lens scan +uvx django-orm-lens scan -f table # every app and model at a glance +uvx django-orm-lens nplusone # N+1 loops, with the select_related to add +uvx django-orm-lens migration-risk # migrations that lock tables or fail on existing rows ``` -Cold clone, broken venv, no settings module — you still get every app, model, field, and relation of the project in your terminal. +Cold clone, broken venv, no settings module — you still see every app and model of the project, then the N+1 loops and risky migrations in it, right in your terminal. (`uvx` is from [uv](https://docs.astral.sh/uv/); `pipx run` works the same way.) **Then pick your surface** — three distributions, one parser core: diff --git a/docs/i18n/README.es.md b/docs/i18n/README.es.md index 37b831a..c59e44e 100644 --- a/docs/i18n/README.es.md +++ b/docs/i18n/README.es.md @@ -45,10 +45,12 @@ Todo tu grafo de modelos — en vivo en la barra lateral de tu editor, actuando ## ⚡ 10 segundos hasta el primer insight ```bash -uvx django-orm-lens scan # or: pipx run django-orm-lens scan +uvx django-orm-lens scan -f table # every app and model at a glance +uvx django-orm-lens nplusone # N+1 loops, with the select_related to add +uvx django-orm-lens migration-risk # migrations that lock tables or fail on existing rows ``` -Un clon en frío, un venv roto, sin módulo de settings — aun así obtienes cada aplicación, modelo, campo y relación del proyecto en tu terminal. +Un clon en frío, un venv roto, sin módulo de settings — aun así ves cada aplicación y modelo del proyecto, y después los bucles N+1 y las migraciones de riesgo, en tu terminal. (`uvx` viene de [uv](https://docs.astral.sh/uv/); `pipx run` funciona igual.) **Después elige tu superficie** — tres distribuciones, un mismo núcleo de análisis: diff --git a/docs/i18n/README.ru.md b/docs/i18n/README.ru.md index 254eb27..0d1ed79 100644 --- a/docs/i18n/README.ru.md +++ b/docs/i18n/README.ru.md @@ -45,10 +45,12 @@ ## ⚡ 10 секунд до первого инсайта ```bash -uvx django-orm-lens scan # or: pipx run django-orm-lens scan +uvx django-orm-lens scan -f table # every app and model at a glance +uvx django-orm-lens nplusone # N+1 loops, with the select_related to add +uvx django-orm-lens migration-risk # migrations that lock tables or fail on existing rows ``` -Холодный клон, сломанный venv, нет settings-модуля — вы всё равно получаете каждое приложение, модель, поле и связь проекта прямо у себя в терминале. +Холодный клон, сломанный venv, нет settings-модуля — вы всё равно видите все приложения и модели проекта, а затем N+1 в циклах и опасные миграции, прямо в терминале. (`uvx` — из [uv](https://docs.astral.sh/uv/); `pipx run` работает так же.) **Затем выберите свою поверхность** — три дистрибутива, одно ядро парсера: diff --git a/docs/i18n/README.zh.md b/docs/i18n/README.zh.md index 43dfad3..1e1fabc 100644 --- a/docs/i18n/README.zh.md +++ b/docs/i18n/README.zh.md @@ -45,10 +45,12 @@ ## ⚡ 10 秒获得第一份洞察 ```bash -uvx django-orm-lens scan # or: pipx run django-orm-lens scan +uvx django-orm-lens scan -f table # every app and model at a glance +uvx django-orm-lens nplusone # N+1 loops, with the select_related to add +uvx django-orm-lens migration-risk # migrations that lock tables or fail on existing rows ``` -冷克隆、坏掉的 venv、没有 settings 模块 —— 项目的每个 app、模型、字段和关系依然会出现在你的终端里。 +冷克隆、坏掉的 venv、没有 settings 模块 —— 你依然能在终端里看到项目的每个 app 和模型，以及其中的 N+1 循环和高风险迁移。（`uvx` 来自 [uv](https://docs.astral.sh/uv/)；`pipx run` 用法相同。） **接着选择你的使用面** —— 三种发行形式，同一个解析器内核：