Add JOSS and github stars badge to readme

[jan-janssen]

Summary by CodeRabbit

• Documentation
  • Updated the project documentation by adding two badges. One badge displays the current status of the associated published paper, and the other shows the repository's star count, highlighting community engagement and project popularity.

[coderabbitai]

Walkthrough

This update to the repository’s README file adds two visual badges at the top: one displaying the current status of the JOSS paper and another showing the GitHub star count. These changes aim to immediately highlight the project's credibility and community engagement. There were no modifications to the declarations of exported or public entities.

Changes

File(s)	Change Summary
README.md	Added a JOSS paper status badge and a GitHub star count badge at the top section.
Exported/Public Entities	No alterations made.

Poem

Oh, I’m a rabbit with a coding tune,
Two shiny badges make the README bloom.
JOSS status and stars now proudly displayed,
Hopping through changes in a joyful parade.
CodeRabbit cheers with a joyful zoom!

---

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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.44%. Comparing base (3cbd96f) to head (b94cc35).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #623   +/-   ##
=======================================
  Coverage   96.44%   96.44%           
=======================================
  Files          28       28           
  Lines        1265     1265           
=======================================
  Hits         1220     1220           
  Misses         45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

6-6: GitHub Stars Badge Feedback:
The GitHub stars badge is inserted correctly; however, consider wrapping it in a clickable link to your repository’s stars page for enhanced user interactivity—this also aligns with the approach taken for the JOSS badge.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3cbd96f and b94cc35.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
• GitHub Check: notebooks_integration
• GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
• GitHub Check: notebooks
• GitHub Check: unittest_win

🔇 Additional comments (1)

README.md (1)

5-5: JOSS Badge Added Correctly:
The JOSS status badge is added with clear Markdown syntax and links properly to the JOSS paper status page, supporting the project's credibility.