Restructure the README

[aviseth]

Badges, installation, reference tables for configuration and commands, and a factual comparison against neighbouring tools. Content is the same, the structure makes it findable.

The README is baked into the PyPI release, so this needs a 0.1.1 to appear on the project page.

Summary by CodeRabbit

• Documentation
  • Reworked the README to clarify import measurement, auditing, application, and CI budget capabilities.
  • Added quick-start guidance, supported target formats, configuration details, command references, and comparison advice.
  • Documented audit results, lock-file checks, runtime behavior, skipped imports, and updated output examples.
  • Added project badges and streamlined outdated or duplicated content.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ea2bfe11-39bb-4992-9a40-f691fb81b981

📥 Commits

Reviewing files that changed from the base of the PR and between 1853253 and b7d408f.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README was substantially rewritten to document import measurement, auditing, deferred imports, CI budgets, configuration, command usage, and runtime behavior.

Changes

Documentation Refresh

Layer / File(s)	Summary
Product overview and quick start README.md	The introduction presents importcost as an import measurement and auditing tool. It adds badges, Python-version requirements, runtime fallback behavior, and a concise profile example.
Measurement, audit, and apply workflows README.md	The documentation covers target forms, median measurements, audit verdicts, unsafe-set bisecting, --min-saving-ms, output styles, and CI budget configuration. The CI example includes check --update and module-set differences in import.lock.
Reference and runtime notes README.md	The README adds configuration and command-reference tables, a test example, comparison guidance, and notes on safety-test scope, eager-profile savings, file-scoped verification, skipped imports, annotations, namespace packages, and runtime dependencies.

Estimated code review effort: 2 (Simple) | ~10 minutes

Poem

I’m a rabbit with a README to thump,
New import trails now clearly jump.
Profiles, audits, budgets align,
Lock files mark the module line.
I nibble docs and hop away—
The commands are clear today!

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}