Minor fixes in README

[danciaclara]

Description

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• Feature (non-breaking change which adds functionality)
• Improvement (change that would cause existing functionality to not work as expected)
• Code refactoring
• Performance improvements
• Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

• Documentation
  • Updated README with a new project tagline
  • Refined language for instance administration description
  • Added emoji to "Built with" section header
  • Improved formatting of technology badges

[coderabbitai]

Walkthrough

The pull request introduces minor modifications to the README.md file of the Plane project. The changes include adding a new tagline, updating the description of instance administration, incorporating an emoji in a section header, and reformatting the technology badges section. These updates aim to improve the clarity and visual presentation of the project's documentation without changing its fundamental structure or functionality.

Changes

File	Change Summary
README.md	- Added tagline: "Open-source project management that unlocks customer value" - Updated "manage and customize settings" to "configure instance settings" - Added emoji (⚙️) to "Built with" section header - Removed line breaks between technology badges

Possibly related PRs

• Updated README.md #6182: Similar improvements to the README.md file, focusing on enhancing the introductory description and clarifying instance administration details

Suggested reviewers

• sriramveeraghanta

Poem

🐰 A README's tale, crisp and bright,
Words polished with emoji's light
Badges aligned, descriptions clear
Plane's docs now sparkle, drawing near
Open-source magic, just right! 🚀

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

61-61: Consider clarifying the "God mode" terminology

While the revised wording about configuring instance settings is more precise, the term "God mode" might not be immediately clear to new users. Consider adding a brief explanation in parentheses.

-`Instance admins` can configure instance settings with [God mode](https://developers.plane.so/self-hosting/govern/instance-admin).
+`Instance admins` can configure instance settings using [God mode (administrator dashboard)](https://developers.plane.so/self-hosting/govern/instance-admin).

---

122-123: Maintain consistent spacing between technology badges

While the compact presentation is good, the Node.js badge appears to be separated by an extra newline. Consider maintaining consistent spacing between all badges.

[![Next JS](https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white)](https://nextjs.org/)
[![Django](https://img.shields.io/badge/Django-092E20?style=for-the-badge&logo=django&logoColor=green)](https://www.djangoproject.com/)
-
[![Node JS](https://img.shields.io/badge/node.js-339933?style=for-the-badge&logo=Node.js&logoColor=white)](https://nodejs.org/en)
+[![Node JS](https://img.shields.io/badge/node.js-339933?style=for-the-badge&logo=Node.js&logoColor=white)](https://nodejs.org/en)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c1407da and 7e31edb.

📒 Files selected for processing (1)

• README.md (3 hunks)

🔇 Additional comments (2)

README.md (2)

9-9: Great addition of a clear and impactful tagline!

The new tagline effectively communicates the project's value proposition while maintaining consistent formatting with the document.

---

121-121: LGTM! Nice touch with the emoji

The gear emoji is a fitting choice for the technical section and enhances visual engagement.