docs: streamline README and update usage

[jorgeMFS]

Summary

Streamline and reorganize the README to provide clear installation instructions and richer CLI/GUI usage examples.

Documentation:

• Add a dedicated Installation section with instructions for PyPI, source installation, and local development
• Revise Quick Start and Examples sections with concrete CLI commands for single and batch processing
• Consolidate and reformat key CLI flags and parameters into a more concise list
• Restructure the GUI section to outline the workflow steps in the Streamlit interface
• Update the last updated timestamp to August 10, 2025

[sourcery-ai]

Reviewer's Guide

This PR streamlines the README by reorganizing its structure, inserting clear installation steps, condensing and updating CLI/GUI usage examples, refreshing the examples and scripts list, and cleaning up outdated and redundant sections.

File-Level Changes

Change	Details	Files
Reorganize and simplify overall README structure	Move Installation section above Quick Start Consolidate duplicate Installation and Usage blocks Reorder main headings for clearer navigation	README.md
Add explicit installation instructions	Provide PyPI and source installation commands Include local development run instructions Reference dependencies in requirements.txt	README.md
Condense and update CLI usage details	Group flags under “Useful flags” and “Key parameters” Remove outdated JSON config examples Streamline report outputs description	README.md
Simplify GUI section	Reduce launch instructions to a single Streamlit command Outline core workflow steps in numbered list Remove legacy GUI highlights	README.md
Refresh examples, scripts, and metadata	Prune and list current scripts with brief descriptions Standardize example command headings Update ‘Last updated’ date to August 10, 2025	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @jorgeMFS - I've reviewed your changes - here's some feedback:

• The table of contents includes a "Configuration" section but no corresponding content—either add a brief YAML config overview or remove that TOC entry.
• Installation notes reference requirements.txt but don’t call out dev/test dependencies (pandas, numpy, yaml) needed for pytest—consider listing or separating those.
• It might help to add a PyPI badge or link in the Installation section so users can jump directly to the package page.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- The table of contents includes a "Configuration" section but no corresponding content—either add a brief YAML config overview or remove that TOC entry.
- Installation notes reference requirements.txt but don’t call out dev/test dependencies (pandas, numpy, yaml) needed for pytest—consider listing or separating those.
- It might help to add a PyPI badge or link in the Installation section so users can jump directly to the package page.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}