chore: add readme and all contributors

[steveiliop56]

Summary by CodeRabbit

• Documentation
  • Introduced a new configuration file for project contributors.
  • Overhauled the README.md to reflect the transition to a Rust-based implementation, including updated installation and build instructions, new sections on contributing, license, community, acknowledgements, and contributors, along with updated support and security disclaimers.

[coderabbitai]

Warning

Rate Limit Exceeded

@steveiliop56 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 58 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.

Commits

Files that changed from the base of the PR and between 4011e9a and e1c52d0.

Walkthrough

The project, known as Runtipi CLI, has transitioned from TypeScript to Rust, marking a significant shift in its development approach. This change is documented through a new configuration file and a comprehensive update to the README.md, which now includes detailed instructions, community engagement guidelines, and acknowledgements, all reflecting the project's new Rust-based journey.

Changes

File	Change Summary
.all-contributorsrc	Introduced to configure project details like name "cli" and owner "runtipi".
README.md	Overhauled to reflect shift to Rust, including updated instructions, sections for community, contributing, license, acknowledgements, and a list of contributors.

"In the realm of code, where the bits frolic and play,
A project shifts shape, in a Rusty display.
🐇 From TypeScript pastures, to Rust fields it hops,
With a README rewritten, the change never stops." 🌟

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 783c52c and 4011e9a.

Files ignored due to path filters (1)

• images/cli.png is excluded by: !**/*.png

Files selected for processing (2)

• .all-contributorsrc (1 hunks)
• README.md (1 hunks)

Additional comments: 7

.all-contributorsrc (1)

• 1-4: The .all-contributorsrc file is correctly formatted and includes the necessary fields (projectName and projectOwner). This setup should work well with the all-contributors bot or CLI tool for recognizing contributions to the project.

README.md (6)

• 1-12: The introduction and badges section is well-structured, providing immediate visibility to the project's license, version, issue tracking, and contributor count. The transition to Rust is highlighted, which aligns with the PR's objectives. The use of badges for dynamic information is a good practice.
• 20-24: The "Getting Started" section clearly instructs users on how to transition from the old CLI to the new Rust-based CLI. The warning about version compatibility is crucial and well-placed. This section is clear and concise.
• 26-40: The "Building locally" instructions are straightforward and provide a simple, step-by-step guide for users interested in compiling the CLI themselves. It's good practice to include such instructions, especially for open-source projects. The mention of cargo and rust prerequisites is important for newcomers.
• 46-50: The "License" section is clear and provides essential information about the project's licensing, including a brief explanation of the GPL v3.0 terms. This is helpful for users and contributors to understand their rights and obligations when using or contributing to the project.
• 52-57: The "Community" section effectively directs users to the project's social platforms. Including links to Twitter and Discord encourages community engagement and provides channels for support and discussion.
• 57-75: The "Acknowledgements" and "Contributors" sections are well-intended, fostering a sense of community and recognition. However, ensure the contributors' list is actively managed either manually or through the all-contributors bot to keep it up-to-date. The link to issue Contributors #11 for contributor name requests is a good practice for managing contributions recognition.