Tutorial video for socialsharebutton analytics integration

[swathi2006]

Addressed Issues:

Fixes #94

Screenshots/Recordings:

readme

video : https://drive.google.com/file/d/1h1e9hJHqA3UXhF12KAP-NlkwkLIrlose/view?usp=drive_link

Additional Notes:

This PR adds a beginner-friendly video tutorial demonstrating integration of SocialShareButton analytics.

Highlights

• Clear 3-step integration (CDN, HTML container, initialization)
• Live demo of the share button in a sample webpage
• Real-time analytics demonstration using debug mode (debug: true)
• Shows events such as:
  • social_share_popup_open
  • social_share_click
  • social_share_copy
• Demonstrates platform interaction

Checklist

• My code follows the project's code style and conventions
• I have made corresponding changes to the documentation
• My changes generate no new warnings or errors
• I have joined the Discord server and I will share a link to this PR with the project maintainers there
• I have read the Contributing Guidelines

⚠️ AI Notice - Important!

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact. AI slop is strongly discouraged and may lead to banning and blocking. Do not spam our repos with AI slop.

Summary by CodeRabbit

• Documentation
  • Added a "🎥 Video Tutorial: Manual Integration + Analytics" section to the README with a visual walkthrough, a "What this video covers" checklist (live demo, real-time analytics events for popup open/click/copy, and platform interactions like Twitter/WhatsApp/Pinterest), a development tip to enable debug logging in the browser console, and a demo video link.

[coderabbitai]

Warning

Rate limit exceeded

@swathi2006 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 12 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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: bc61feed-445d-4f72-97c0-b72f9ab2e4c8

📥 Commits

Reviewing files that changed from the base of the PR and between a8eb640 and 05ae5d8.

📒 Files selected for processing (1)

• README.md

Walkthrough

Added a new "🎥 Video Tutorial: Manual Integration + Analytics" section to README documenting a visual walkthrough, listed runtime analytics events (popup open/click/copy and platform interactions), a debug: true tip for console logging, and a Google Drive demo video link.

Changes

Cohort / File(s)	Summary
Documentation README.md	Inserted "🎥 Video Tutorial: Manual Integration + Analytics" section after the 3-step integration overview. Adds a "What this video covers" bullet list (live demo, real-time analytics events, platform interactions), a development tip to enable debug: true, a "Demo Video" subsection with a Google Drive link, and surrounding horizontal separators.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Add integration skill for SocialShareButton with detailed setup instr… #64 — README/integration documentation updates that relate to tutorial and integration guidance.

Suggested labels

Documentation

Suggested reviewers

• kpj2006

Poem

🐇 I hopped into the README bright and merry,
Showing how to plug the button and watch events carry,
A debug tip tucked in the console glow,
A demo link to press and watch metrics flow,
🥕 Tap play — analytics hop, click, and go!

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: adding a tutorial video section to the README for SocialShareButton analytics integration.
Linked Issues check	✅ Passed	The PR fulfills all coding-related requirements from issue #94: adds a video tutorial link to README, demonstrates integration steps, covers analytics events, and includes debug mode guidance.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to issue #94 requirements: the README update includes only the video tutorial section, Google Drive link, integration steps, and analytics guidance as specified.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

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

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 116: Remove the single trailing space at the end of the sentence "Prefer
a visual walkthrough? This short tutorial demonstrates how to integrate
SocialShareButton step-by-step and" (the line shown in the diff) so the line has
no trailing whitespace; also scan the surrounding lines for other stray trailing
spaces and re-run markdownlint (MD009) to verify the fix.
- Around line 125-126: Add a single blank line between the tip paragraph that
starts with "💡 Tip: Enable `debug: true` during development to log analytics
events in the browser console." and the heading "### Demo Video" so the heading
is separated from the preceding block (fixes markdownlint MD022).

🪄 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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: da048a51-d624-4ee7-b334-f979d768c7f3

📥 Commits

Reviewing files that changed from the base of the PR and between 1427157 and 991a6a8.

📒 Files selected for processing (1)

• README.md

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 116-117: The intro sentence in README.md repeats "demonstrates"
and should be tightened; replace it with a single clearer phrasing such as
"Prefer a visual walkthrough? This short tutorial shows how to integrate
SocialShareButton step-by-step and covers real-time analytics events and user
interactions." Update the sentence so it uses one verb (e.g., "shows" or
"demonstrates") and keeps the rest of the meaning intact.
- Around line 121-125: Update the README bullets to use the canonical analytics
event names instead of generic descriptions: replace "Real-time analytics events
(popup open, click, copy)" with explicit keys like social_share_popup_open,
social_share_click, social_share_copy and update the Tip line to reference those
exact keys so readers can match console output when debug: true is enabled;
ensure the three bullets and the Tip text consistently use these canonical event
names.

🪄 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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2cbd7e5e-8326-4550-a72a-1d73abd22243

📥 Commits

Reviewing files that changed from the base of the PR and between 991a6a8 and 9d76a68.

📒 Files selected for processing (1)

• README.md

[swathi2006]

Hi @kpj2006,

I’ve addressed all the requested changes and updated the README accordingly.
Could you please review ?