docs: full README rewrite for Push-to-Issue AI Logger

[OstinUA]

Motivation

• Replace the minimal placeholder with a complete, professional README.md that documents the repository's purpose as a GitHub Actions-driven logging automation which analyzes trusted commits with Gemini and opens structured GitHub Issues.
• Surface operational requirements and security-relevant runtime constraints such as required secrets and the ALLOWED_USER gate so operators can safely run the workflow.
• Provide clear onboarding (install, run, test) and deployment guidance so the project is usable and maintainable by other developers and CI pipelines.

Description

• Fully replaced README.md with an exhaustive guide that adds title, tagline, badges, a linked Table of Contents, and a complete Features list describing capabilities like diff extraction, truncation guards, JSON output schema, and the security label behavior.
• Documented Tech Stack and Architecture with a project tree, key design decisions, and a Mermaid data-flow diagram that explains how a push event becomes a generated issue via process_push.py and Gemini.
• Added step-by-step Getting Started, Installation, Testing, Deployment, Usage, and Configuration sections that list prerequisites, environment variables, sample commands, and operational cautions (including the ALLOWED_USER .strip() crash risk).
• Declared the project license as GNU AGPL v3 and appended the exact requested "Support the Project" markdown block with all provided badges/links.

Testing

• Performed a static syntax check using python -m py_compile process_push.py, which completed successfully.
• No unit or integration tests were present or modified in this change, and no code behavior in process_push.py was altered by this documentation-only update.

---

Codex Task

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

[coderabbitai]

Warning

Rate limit exceeded

@OstinUA has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 29 minutes and 54 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d84cfbe3-fda4-4758-9bf7-027f11e0c6a4

📥 Commits

Reviewing files that changed from the base of the PR and between 55e2cfa and cf502a6.

📒 Files selected for processing (1)

• README.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/create-detailed-readme.md-for-logging-library

📝 Coding Plan

• Generate coding plan for human review comments

---

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 and usage tips.}