Refresh README before announcing the new FetchIt features

[cooktheryan]

The README still contains a broken /opt/config.yaml mount, a cleanup command that deletes persistent engine state, and little guidance on current features. Refresh it before publicizing the recent work.

Add an overview of Quadlet, opt-in cleanup/rollback, kube networks/labels/SOPS, mirrors, status, and multi-architecture samples. Provide one rootless quick start with the correct /opt/mount config path and verified welcome container name. Document state retention, source builds on amd64/arm64, compatible helpers, rootful/rootless scope, and unreleased-image limitations. Link to the updated guides for detailed operations.

Validation: README YAML and shell syntax, all local guide links, sample name/port cross-check, strict Sphinx build, and git diff checks passed.

Summary by Sourcery

Refresh the README with accurate quick-start instructions and comprehensive guidance for current FetchIt features and operating constraints.

Bug Fixes:

• Correct the README quick-start mount and cleanup instructions to preserve FetchIt state and use the verified sample container name.

Enhancements:

• Refresh the README with current guidance for Quadlet, lifecycle cleanup and rollback, Kubernetes networks and labels, SOPS, mirrors, status endpoints, multi-architecture samples, source builds, helper compatibility, and rootful/rootless operation.
• Consolidate quick-start, operation, state-retention, unreleased-image, and troubleshooting guidance with links to the relevant detailed guides.

Documentation:

• Update the README to document current FetchIt capabilities, supported environments, quick start, development workflow, and documentation resources.

[sourcery-ai]

Sorry @cooktheryan, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 6 days and 17 hours by commenting @sourcery-ai review. Upgrade to get a review now.

[sourcery-ai]

Reviewer's Guide

Refreshes README.md into a current, safety-conscious guide: it presents FetchIt’s new features, provides a corrected rootless quick start and non-destructive cleanup instructions, documents architecture and helper compatibility, and consolidates build, test, and documentation validation guidance.

State diagram for FetchIt demonstration cleanup

stateDiagram-v2
    [*] --> Running
    Running --> Stopped: podman stop fetchit
    Stopped --> EngineRemoved: podman rm fetchit
    EngineRemoved --> DemoCleaned: podman rm -f welcome
    DemoCleaned --> StateRetained: keep fetchit-volume
    StateRetained --> [*]

Loading

Flow diagram for the FetchIt rootless quick start

flowchart LR
    A[Enable rootless Podman socket] --> B[Create $HOME/.fetchit/config.yaml]
    B --> C[Run FetchIt with fetchit-volume and /opt/mount]
    C --> D[Reconcile welcome-to-fetchit]
    D --> E[Open status or sample endpoint]

Loading

File-Level Changes

Change	Details	Files
Replaces the introductory README content with a current feature overview and links to detailed operational guides.	Summarizes Quadlet, lifecycle cleanup and rollback, kube networks and labels, SOPS, mirrors, status endpoints, and sample applications. Clarifies unreleased-feature/image limitations, state retention, rootful/rootless scope, helper compatibility, and source-build architecture support. Adds links to the relevant local guides, release notes, and running documentation.	README.md
Reworks the quick-start workflow around a rootless Podman deployment with corrected configuration mounting and verified sample behavior.	Uses $HOME/.fetchit:/opt/mount and documents /opt/mount/config.yaml as the configuration path. Adds a welcome-to-fetchit raw target, container log/status checks, and localhost:9191 verification. Documents the sample image, port mapping, user, multi-architecture variants, reload behavior, and lingering. Replaces destructive cleanup with scoped engine/sample removal while preserving fetchit-volume state.	README.md
Adds current-main build, compatibility, and validation guidance.	Documents amd64/arm64 source builds and consistent Podman stores for rootful or rootless use. Explains helper image selection, fixed helper references, local tagging, and production digest guidance. Updates unit-test prerequisites, SOPS test requirements, strict Sphinx build commands, and documentation publishing notes.	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.