docs: updating readme

[lotyp]

Summary by CodeRabbit

• Documentation
  • Updated image sources and author information in the README.
  • Added new resource links and enhanced the presentation of images with clickable links.

[coderabbitai]

Walkthrough

This update enhances the presentation and accuracy of the project's README. It involves updating image sources within a specific section, encapsulating these images in hyperlinks, and correcting the author's GitHub profile information. Additionally, it enriches the document with new resource links, improving navigation and user engagement.

Changes

File	Change Summary
README.md	Updated image sources, added image links, corrected author's GitHub link, added new resource links

Poem

🐰💻✨
In the garden of code, where the bits all play,
A small rabbit hopped, updating away.
Links like carrots, fresh and new,
Images framed, in a digital view.
Hop, hop, hooray, for changes today!

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5881072 and 75e4b9a.

Files selected for processing (1)

• README.md (2 hunks)

Additional Context Used

LanguageTool (56)

README.md (56)

Near line 29: Possible spelling mistake found.
Context: ...ion), specifically designed for use in wayofdev projects....

---

Near line 31: Opting for a less wordy alternative here can improve the clarity of your writing.
Context: ...n into multiple projects. This approach not only reduces the need to rewrite code but also ensures standardized operations across all Wayo...

---

Near line 31: Possible spelling mistake found.
Context: ...ures standardized operations across all Wayofdev repositories.
## 📋 Table of Con...

---

Near line 70: Possible typo: you repeated a whitespace
Context: ...ructions on how to use it. | Action | Description ...

---

Near line 70: Possible typo: you repeated a whitespace
Context: ... | Description | |-------------------------------------...

---

Near line 72: Possible typo: you repeated a whitespace
Context: ...ry path and exports it as env variable. | | [composer/get-root-version](./acti...

---

Near line 73: Possible typo: you repeated a whitespace
Context: ...ons/composer/get-root-version/README.md) | determines the Composer root version b...

---

Near line 74: Possible typo: you repeated a whitespace
Context: ...`](./actions/composer/install/README.md) | Installs dependencies with Composer ba...

---

Near line 74: Possible typo: you repeated a whitespace
Context: ...ased on the specified dependency level. | | [phive/install](./actions/phive/in...

---

Near line 75: Possible spelling mistake found.
Context: ...ndency level. | | [phive/install](./actions/phive/install/READM...

---

Near line 75: Possible typo: you repeated a whitespace
Context: ...all`](./actions/phive/install/README.md) | Install dependencies with [Phive](http...

---

Near line 75: Possible spelling mistake found.
Context: ... | Install dependencies with Phive. ...

---

Near line 75: Possible typo: you repeated a whitespace
Context: ...ndencies with Phive. | | [playwright/install](./actions/pla...

---

Near line 76: Possible typo: you repeated a whitespace
Context: ...(./actions/playwright/install/README.md) | Installs [Playwright](https://playwrig...

---

Near line 76: Possible typo: you repeated a whitespace
Context: ...ight.dev/) along with its dependencies. | | [pnpm/install](./actions/pnpm/inst...

---

Near line 77: Possible spelling mistake found.
Context: ...ependencies. | | [pnpm/install](./actions/pnpm/install/README...

---

Near line 77: Possible typo: you repeated a whitespace
Context: ...tall`](./actions/pnpm/install/README.md) | Installs mono-repository dependencies ...

---

Near line 77: Possible spelling mistake found.
Context: ...lls mono-repository dependencies using PNPM. ...

---

Near line 77: Possible typo: you repeated a whitespace
Context: ...dencies using PNPM. | | [s3/cache](./actions/s3/cache/READ...

---

Near line 78: Possible typo: you repeated a whitespace
Context: ...s3/cache`](./actions/s3/cache/README.md) | Cache artifacts, or restore them using...

---

Near line 78: Possible typo: you repeated a whitespace
Context: ...he artifacts, or restore them using S3. |
## ⚙️ Workflows Read more abou...

---

Near line 92: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ests and make it easier to identify the type of changes included. To use this workflow, set up...

---

Near line 94: The official name of this software platform is spelled with a capital “H”.
Context: ...cluded. To use this workflow, set up a .github/labeler.yml file with your configurati...

---

Near line 94: Possible spelling mistake found.
Context: ...ore information on how to configure the labeler, see: https://github.com/actions/labele...

---

Near line 145: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...

---

Near line 151: Possible spelling mistake found.
Context: ...erges releases. This workflow utilizes [peter-evans/enable-pull-request-automerge](https://...

---

Near line 151: Possible spelling mistake found.
Context: ...es. This workflow utilizes [peter-evans/enable-pull-request-automerge](https://github.com/peter-evans/enable-...

---

Near line 151: Possible spelling mistake found.
Context: ...uto-merge releases that are created by [googleapis/release-please](https://github.com/goog...

---

Near line 186: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...

---

Near line 192: Possible spelling mistake found.
Context: ...his workflow creates a release based on changesets. This workflow utilizes [changesets/act...

---

Near line 192: Possible spelling mistake found.
Context: ... on changesets. This workflow utilizes [changesets/action](https://github.com/changesets/a...

---

Near line 192: Possible spelling mistake found.
Context: ...ts/action) to create a release based on changesets. Here is an example of how to use this...

---

Near line 223: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/next-starter-tpl](https://github.com/w...

---

Near line 235: Possible spelling mistake found.
Context: ... repositories, using this workflow: * [wayofdev/docker-node](https://github.com/wayofde...

---

Near line 295: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/docker-node](https://github.com/wayofd...

---

Near line 303: Possible spelling mistake found.
Context: ...ram.yml:` This workflow leverages the [codesee-io/codesee-action](https://github.com/Code...

---

Near line 303: Possible spelling mistake found.
Context: ...This workflow leverages the [codesee-io/codesee-action](https://github.com/Codesee-io/codesee-...

---

Near line 304: Possible spelling mistake found.
Context: ...ebase whenever a pull request is made. CodeSee is an open-source tool that helps visua...

---

Near line 342: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...

---

Near line 350: Possible spelling mistake found.
Context: ... shellcheck.yml: This workflow uses [redhat-plumbers-in-action/differential-shellcheck](https://github...

---

Near line 350: Possible spelling mistake found.
Context: ...orkflow uses [redhat-plumbers-in-action/differential-shellcheck](https://github.com/redhat-plumbers-in-...

---

Near line 381: Possible spelling mistake found.
Context: ...Real-world examples can be found in the [wayofdev/laravel-package-tpl](https://github.co...

---

Near line 393: The official name of this software platform is spelled with a capital “H”.
Context: ...icy This project has a security policy.
## 🙌 Want to Cont...

---

Near line 399: Possible spelling mistake found.
Context: ...you for considering contributing to the wayofdev community! We are open to all kinds of ...

---

Near line 399: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...are open to all kinds of contributions. If you want to: - 🤔 Suggest a feature - 🐛 Report an...

---

Near line 406: The official name of this software platform is spelled with a capital “H”.
Context: ...indly check our contribution guidelines.
## 🌐 Social L...

---

Near line 413: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ...low?screen_name=wlotyp). - Discord: Join our community on [Discord](https://disc...

---

Near line 419: Possible spelling mistake found.
Context: ...or Information Created in 2023 by lotyp @ [wayofdev]...

---

Near line 419: Possible spelling mistake found.
Context: ...by lotyp @ wayofdev
##...

---

Near line 427: This sentence does not start with an uppercase letter.
Context: ...the-difference-github-actions-11kd) * [cycle/gh-actions](https://github.com/cycle/gh...

---

Near line 427: Possible spelling mistake found.
Context: ...fference-github-actions-11kd) * cycle/gh-actions —...

---

Near line 429: This sentence does not start with an uppercase letter.
Context: ...s://github.com/cycle) organization. * [ergebnis/.github](https://github.com/ergebnis/.g...

---

Near line 429: The official name of this software platform is spelled with a capital “H”.
Context: ....com/cycle) organization. * ergebnis/.github —...

---

Near line 429: Unpaired symbol: ‘[’ seems to be missing
Context: ...ycle) organization. * ergebnis/.github — ...

---

Near line 431: This sentence does not start with an uppercase letter.
Context: .../github.com/ergebnis) organization. * [skills/reusable-workflows](https://github.com/...

---

Near line 431: Unpaired symbol: ‘[’ seems to be missing
Context: ...anization. * [skills/reusable-workflows](https://github.com/skills/reusable-work...

Additional comments not posted (2)

README.md (2)

4-9: The updates to the image sources and the addition of the hyperlink are well-implemented and enhance the visual appeal and navigability of the README.

---

419-419: The update to the author information with the new GitHub profile link is correctly implemented.

---

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.

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