docs(README): add reference to the audit report

[ccamel]

Thought it’d be a good idea to include the audit report in the README to make it clear.

Summary by CodeRabbit

• New Features
  • Introduced an "Audit" section in the README, enhancing transparency regarding project audits.
  • Added a structured audit table detailing audit dates, auditors, project versions, and links to reports.

[coderabbitai]

Walkthrough

The changes introduce a new "Audit" section in the README.md file, which includes a structured table detailing the audit history of the project. This table comprises columns for the audit date, auditor's name, project version, and a link to the audit report. The integration of this section aims to enhance the project's documentation by providing clear information regarding its security and compliance audits.

Changes

File	Change Summary
README.md	Added ## Audit section with an audit table containing columns: Date, Auditor, Version, Report.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant README
    User->>README: View project documentation
    README->>User: Display project details
    README->>User: Show Audit section
    User->>README: Review audit history

Loading

Poem

In the garden of code, where the audits bloom,
A table now shines, dispelling the gloom.
With dates and reports, our history's clear,
For users and contributors, there's nothing to fear!
🐇✨

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dd15c41 and 0d38770.

Files selected for processing (1)

• README.md (1 hunks)

Files skipped from review due to trivial changes (1)

• README.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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.

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 ✅

@@           Coverage Diff           @@
##             main     #747   +/-   ##
=======================================
  Coverage   54.49%   54.49%           
=======================================
  Files          73       73           
  Lines        2905     2905           
=======================================
  Hits         1583     1583           
  Misses       1228     1228           
  Partials       94       94           

[amimart]

Completely agree thanks!

[bdeneux]

Seems like a good idea 👍