docs: improve README with installation examples

[tmdeveloper007]

Summary

This PR improves the README with better installation examples and usage snippets.

Changes

• Added detailed installation instructions
• Added code examples for common use cases
• Improved formatting and structure

Automated GSSOC PR

---

Automated GSSOC PR - 2026-07-27 13:32 UTC

Summary by CodeRabbit

• Documentation
  • Added installation instructions and code examples.
  • Added a summary of documentation updates and automation metadata.

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds docs/AUTOMATION_1.md with a summary of README installation instructions, usage examples, and automated PR metadata.

Changes

Automation Documentation

Layer / File(s)	Summary
Add automation documentation stub docs/AUTOMATION_1.md	Adds summary and changes sections describing installation instructions and code examples, followed by automated PR footer metadata.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: karanjot786

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	It covers summary and changes, but omits required template sections like Related Issue, Which package(s)?, and the checklist.	Add the missing template sections, especially a linked issue, package scope, type of change, checklist, and reviewer notes.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately summarizes the README installation-example docs update.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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.}

Warning

⚠️ This pull request has been flagged as potential spam (bot-spam) by CodeRabbit slop detection and should be reviewed carefully.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/AUTOMATION_1.md`:
- Around line 11-14: Remove the untimestamped “Automated GSSOC PR” footer from
the document, while retaining the timestamped footer on Line 14 unchanged.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: adbabf41-fc00-4769-ac91-18992ac4843c

📥 Commits

Reviewing files that changed from the base of the PR and between 48f63a1 and 4bc0815.

📒 Files selected for processing (1)

• docs/AUTOMATION_1.md

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Remove the duplicate automation footer.

The document repeats Automated GSSOC PR; retain only the timestamped footer on Line 14.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/AUTOMATION_1.md` around lines 11 - 14, Remove the untimestamped
“Automated GSSOC PR” footer from the document, while retaining the timestamped
footer on Line 14 unchanged.