Enhance the procedure

[5ouma]

⚠️ Issue

close #

✏️ Description

It has become much easier to use this project.

🔄 Type of the Change

• 🎉 New Feature
• 🧰 Bug
• 🛡️ Security
• 📖 Documentation
• 🏎️ Performance
• 🧹 Refactoring
• 🧪 Testing
• 🔧 Maintenance
• 🎽 CI
• 🧠 Meta

• I agree to follow the Code of Conduct.

Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.

[coderabbitai]

Walkthrough

The pull request introduces significant updates to the Mobicard project's README file, changing the setup instructions to emphasize creating a new project using the mobicard template. It modifies the installation commands and restructures the development section, highlighting new steps for configuring the meta.json file. Additionally, the meta file structure is updated with new fields and a change in terminology, improving overall clarity and organization of the documentation.

Changes

File

Change Summary

.github/README.md

Updated usage instructions to create a project with npm create astro --template 5ouma/mobicard. Modified dependency installation commands to bun run build and added bun run preview. Restructured development instructions, emphasizing copying meta.tmpl.json to meta.json and running bun run dev. Updated meta file structure to include new fields: email, sns, and card, replacing contacts with sns. Improved formatting for clarity.

Possibly related PRs

• Add README and license #11: The changes in this PR also involve the README file, which is related to the documentation updates in the main PR, specifically regarding usage instructions and project setup.
• Small fix for texts #25: This PR modifies the README file by updating a link, which is a minor change but still pertains to the documentation aspect of the project, similar to the updates made in the main PR.

---

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>, 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 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]

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)

.github/README.md (2)

25-43: Add prerequisite information for bun usage

The instructions use bun commands but don't mention that Bun needs to be installed first. Consider adding a prerequisites section or noting that other package managers (npm/yarn/pnpm) can also be used.

Add a note before the commands, like:

 3. Build and Preview the project
+   > Prerequisites: Make sure you have [Bun](https://bun.sh) installed, or use your preferred package manager (npm/yarn/pnpm)

---

80-83: Add migration note for existing users

The meta file structure has changed significantly with new fields and the replacement of contacts with sns. Consider adding a migration guide for existing users.

Add a note explaining the changes, like:

> [!IMPORTANT]
> For users upgrading from previous versions:
> - The `contacts` field has been renamed to `sns`
> - New required fields: `email` and `card`

🛑 Comments failed to post (1)

.github/README.md (1)

52-52: ⚠️ Potential issue

Fix incorrect repository URL

The clone URL is pointing to the wrong repository ('reproxy' instead of 'mobicard').

-  git clone https://github.com/5ouma/reproxy.git
+  git clone https://github.com/5ouma/mobicard.git

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

   git clone https://github.com/5ouma/mobicard.git