Skip to content

docs: add Discord and npm badges to README#140

Merged
patrickkabwe merged 1 commit intomainfrom
docs/add-discord-and-npm-badges
Nov 22, 2025
Merged

docs: add Discord and npm badges to README#140
patrickkabwe merged 1 commit intomainfrom
docs/add-discord-and-npm-badges

Conversation

@patrickkabwe
Copy link
Copy Markdown
Owner

@patrickkabwe patrickkabwe commented Nov 22, 2025

This PR adds Discord and npm badges to the README for better visibility and community engagement.

Changes

  • Added Discord badge linking to the Discord server
  • Added npm version badge
  • Added npm downloads badge
  • Added build status badge
  • Removed redundant Discord community text link

Summary by CodeRabbit

  • Documentation
    • Added npm version, npm downloads, Build, and Discord badges to the project documentation header.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 22, 2025

Walkthrough

Added four badges (npm version, npm downloads, Build status, and Discord) to the README.md header section for branding and project visibility. No functional code changes or modifications to exported entities.

Changes

Cohort / File(s) Change Summary
Badge additions
README.md
Added four badges (npm version, npm downloads, Build, Discord) to the header documentation for branding and project metrics visibility.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Pure documentation update with no code impact; review solely confirms badge syntax and placement are appropriate.

Poem

🐰✨ Four badges now shine so bright,
Like carrots gleaming in moonlight!
npm, downloads, Build, Discord too—
A README dressed in badges new!
Hop along, this change is light! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title clearly and accurately describes the main changes: adding Discord and npm badges to the README. It is concise, specific, and directly reflects the documented objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/add-discord-and-npm-badges

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 505db38 and eed9c3b.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (3)
README.md (3)

5-8: Badge formatting and placement look good.

The badges are consistently formatted with matching styles (for-the-badge), use appropriate logos and colors, follow standard markdown syntax, and are well-placed after the project image. The Discord color code (5865F2) matches the official Discord brand.


5-8: Package name and repository references are consistent throughout.

The npm package name (react-native-nitro-fs) and GitHub repository path (patrickkabwe/react-native-nitro-fs) are consistent with other sections of the README, including the installation instructions and code examples.


5-8: Based on verification results:

Discord invite link valid (HTTP 301 redirect), shields.io badges accessible, GitHub Actions workflow exists. npm package status inconclusive.

The verification confirms:

  • Discord link resolves with HTTP 301 redirect, and shields.io endpoints return HTTP 200
  • GitHub repository patrickkabwe/react-native-nitro-fs exists and is a high-performance file system module for React Native
  • The workflow file referenced (release.yml) exists in the repository

However, the npm package version lookup returned null from the registry API, and web search did not locate the package on npmjs.com directly. This may indicate the package is either unpublished or has registry indexing issues. While jsDelivr CDN shows version 0.5.4 is available, the npm registry state requires confirmation from the maintainer.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@patrickkabwe patrickkabwe merged commit 53df773 into main Nov 22, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant