Update README and docs to accurately describe the formatter/sorter tool

[Copilot]

README and docs/index.md contained scaffold placeholder content (pypfmt hello World) that didn't reflect the implemented tool.

Changes

• README.md / docs/index.md: Replace placeholder content with accurate documentation covering:
  • CLI modes: fix (in-place), --check, --diff, --check --diff, stdin/stdout, multi-file
  • Pre-commit hook setup
  • [tool.pypfmt] configuration reference — sort-first, extend-sort-first, per-table overrides, taplo options, comment handling
  • Default behaviour table clarifying what gets sorted vs. preserved (e.g. pytest.ini_options.addopts is positional — preserved as-is; classifiers and dependencies are sorted alphabetically)

[tool.pypfmt]
extend-sort-first = ["my-custom-tool"]

[tool.pypfmt.extend-overrides]
"project.optional-dependencies.*" = { inline_arrays = true }

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• astral.sh
  • Triggering command: /usr/bin/curl curl -LsSf REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

i created this because i have dozens of python projects and i like to keep all my configuration in the pyproject.toml files.

by having a standard formatter, and sorter, that doesn't corrupt the settings it means i can diff my projects much easier and identify and copy desired changes between projects.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[Copilot]

Pull request overview

Updates the project’s user-facing documentation to replace scaffold/placeholder examples with accurate pypfmt usage and configuration details, aligning README and MkDocs landing page with the implemented CLI and config system.

Changes:

• Replace placeholder CLI content with documented modes (fix, --check, --diff, stdin/stdout, multi-file).
• Add pre-commit integration instructions and [tool.pypfmt] configuration examples.
• Document default “opinionated” ordering/sorting behaviors in a concise reference table.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
README.md	Expands and corrects usage/configuration docs (CLI modes, pre-commit, config reference, defaults).
docs/index.md	Mirrors README-style accurate usage/configuration docs for the MkDocs landing page.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.