add DeepWiki badge

[methane]

Description

Checklist

• Code compiles correctly
• Created tests which fail without the change (if possible)
• All tests passing
• Extended the README / documentation, if necessary
• Added myself / the copyright holder to the AUTHORS file

Summary by CodeRabbit

• Documentation
  • Added a badge linking to DeepWiki for the Go-MySQL-Driver project at the top of the README.

[coderabbitai]

Walkthrough

A badge linking to DeepWiki for the Go-MySQL-Driver project was added at the top of the README file. This badge features a shield image with an embedded base64-encoded logo and a hyperlink to the relevant DeepWiki page. No other modifications were made.

Changes

File	Change Summary
README.md	Added a DeepWiki badge with a base64-encoded logo and hyperlink.

Poem

A shiny new badge at the top,
With a logo that just won't stop!
DeepWiki now just one click away,
Knowledge at paw, hooray hooray!
README’s brighter, info’s in sight—
Rabbits approve, it’s just right! 🐇✨

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

3-3: Avoid embedding large base64 logos in badge URLs
The data URI in the logo= parameter is extremely long, which clutters the README and risks exceeding URL length limits. Consider hosting the DeepWiki logo externally or using a simpler Shields.io logo alias (e.g., logo=deepwiki) to keep the markdown clean.

---

3-3: Enhance image alt text for accessibility
The current alt text "DeepWiki" is minimal. Consider a more descriptive label like "DeepWiki documentation badge for Go-MySQL-Driver" to improve screen-reader clarity.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af56fba and efcd99f.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

3-3: Ensure DeepWiki badge points to the correct page
Please verify that the badge link https://deepwiki.com/go-sql-driver/mysql is valid and leads to the intended documentation or project overview.

[coveralls]

coverage: 82.508% (+0.1%) from 82.413%
when pulling efcd99f on methane:add-deepwiki
into af56fba on go-sql-driver:master.