docs: update readme

[andostronaut]

This is an automated pull request for branch develop

Summary by CodeRabbit

• Documentation
  • Reorganized and updated the content in the README.md file for better clarity and presentation.
  • Updated links and credits related to the template used.

[coderabbitai]

Walkthrough

The README.md file for a portfolio website was reorganized to improve clarity and presentation. Sections like "Getting Started Locally," "Configuration," and "License" were restructured, with updates to links and credits related to the template used. The semantic meaning of the content remained the same, ensuring the document is easier to navigate and read.

Changes

Files	Change Summary
README.md	Reorganized sections ("Getting Started Locally," "Configuration," "License"), updated links and credits.

Poem

In the realm of markdown's grace,
README.md found its place,
Sections shuffled, links refined,
Clarity and ease combined.
A template's credit duly sung,
Configuration neatly strung.
🐇✨ In this tidy, structured space,
Portfolio's charm we now embrace.

---

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 as 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.

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

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]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1daa9a2 and d723b20.

Files ignored due to path filters (1)

• portfolio.png is excluded by !**/*.png

Files selected for processing (1)

• README.md (2 hunks)

Additional comments not posted (3)

README.md (3)

1-1: Header and introduction look good.

The header is clear and the badges are correctly formatted.

Also applies to: 7-7

---

7-9: Credit section is clear and concise.

The acknowledgment to Magic UI is appropriate, and the link is correctly formatted.

---

20-20: Configuration and License sections are well-documented.

The links to the configuration file and the license document are correctly formatted and accessible.

Also applies to: 24-24

[coderabbitai]

Possible typo in command.

The command bun install might be a typo. Typically, the command should be npm install or yarn install unless bun is a specific package manager being used.

- bun install
+ npm install

Committable suggestion was skipped due to low confidence.