docs: use GitHub flavoured markdown for note in Readme

[Roshanjossey]

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have added screenshots if ui has been changed
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• Documentation
  • Fixed README formatting to restore the main header and improve presentation.
  • Reformatted the “Docker is optional” note into a highlighted admonition for clearer visibility.
  • No functional changes; content unchanged aside from presentation—improves onboarding clarity without altering workflows.

[netlify]

👷 Deploy request for appcut pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	bda64fb

[vercel]

@Roshanjossey is attempting to deploy a commit to the OpenCut OSS Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

Updated README.md: fixed a malformed header tag and converted an inline bold note about Docker being optional into a blockquote-style admonition. No logic, public API, or control-flow changes.

Changes

Cohort / File(s)	Summary
Docs formatting README.md	Corrected a malformed header (</span></h1> → <h1>OpenCut</h1>) and replaced an inline bold note about Docker being optional with a blockquote-style admonition; content unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nibbled the README with careful paws,
Tucked broken tags and softened the cause.
No code disturbed, just wording refined—
A neater page for curious minds. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description does not follow the repository’s required template because it lacks a textual summary under the Description heading, omits the Type of change section, and does not detail testing steps under How Has This Been Tested, among other missing template sections.	Please revise the description to include a clear summary of the changes with motivation under a Description heading, select the Type of change checkboxes, provide details in the How Has This Been Tested section, and add any Additional context as specified by the template.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly captures the primary change by indicating the update to the README to use GitHub Flavored Markdown for a note, which directly matches the modification in the pull request.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7460e22 and bda64fb.

📒 Files selected for processing (1)

• README.md (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.md

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

48-49: Use canonical GFM admonition casing and tighten wording.

Prefer NOTE (uppercase) for consistency with GitHub docs and simplify the sentence to avoid the “optional but essential” phrasing.

-> [!Note]
-> Docker is optional, but it's essential for running the local database and Redis services. If you're planning to run the frontend or want to contribute to frontend features, you can skip the Docker setup. If you have followed the steps below in [Setup](#setup), you're all set to go!
+> [!NOTE]
+> Docker is optional unless you need to run the local database and Redis services. If you're only working on the frontend, you can skip Docker. After completing the steps in [Setup](#setup), you're all set.

---

7-7: Fix stray closing span tag in header.

There’s a </span> with no matching <span>; remove it.

-      <h1>OpenCut</span></h1>
+      <h1>OpenCut</h1>

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a346bdf and 7460e22.

📒 Files selected for processing (1)

• README.md (1 hunks)