Skip to content

Revise README for improved clarity and details - #11326

Merged
bturcotte520 merged 3 commits into
mainfrom
briant/updateREADME
Jun 17, 2026
Merged

Revise README for improved clarity and details#11326
bturcotte520 merged 3 commits into
mainfrom
briant/updateREADME

Conversation

@bturcotte520

Copy link
Copy Markdown
Contributor

Updated README to enhance clarity and provide additional details about Kilo Code's features and installation.

Updated README to enhance clarity and provide additional details about Kilo Code's features and installation.
@bturcotte520
bturcotte520 requested a review from olearycrew June 16, 2026 21:43
@bturcotte520 bturcotte520 self-assigned this Jun 16, 2026
Comment thread README.md Outdated
<p align="center">
<img width="100%" alt="Kilo Code running inside VS Code" src="https://kilo.ai/_next/image?url=%2Fscreenshots%2Fvs-code%2Fvs-code-home-page-screenshot.png&w=3840&q=75">
<a href="https://marketplace.visualstudio.com/items?itemName=kilocode.Kilo-Code"><img src="https://raster.shields.io/badge/VS_Code_Marketplace-007ACC?style=flat&logo=visualstudiocode&logoColor=white" alt="VS Code Marketplace" height="20"></a>
<a href="https://www.npmjs.com/package/@kilocode/cli"><img alt="npm" src="https://img.shields.io/npm/v/@kilocode/cli?style=flat-square" /></a>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUGGESTION: npm badge style is inconsistent with other badges in the row

The npm badge uses img.shields.io with ?style=flat-square while all other badges use raster.shields.io with ?style=flat and height="20". This creates a visual mismatch in the badge row.

Consider aligning to the same style as the other badges:

  • Use raster.shields.io instead of img.shields.io
  • Use ?style=flat instead of ?style=flat-square
  • Add height="20" for consistent sizing

Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md Outdated
@kilo-code-bot

kilo-code-bot Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (1 file)
  • README.md
Resolved (2 issues)
File Line Issue
README.md 9 npm badge style inconsistent with other badges ✅
README.md 16 Hero image converted to markdown format ✅
Previous Review Summaries (2 snapshots, latest commit f45003a)

Current summary above is authoritative. Previous snapshots are kept for context only.

Previous review (commit f45003a)

Status: 1 Issue Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 0
SUGGESTION 1
Issue Details (click to expand)

SUGGESTION

File Line Issue
README.md 9 npm badge uses different CDN and style (img.shields.io, flat-square) vs other badges (raster.shields.io, flat, height="20")
Resolved (1 issue)
File Line Issue
README.md 16 Hero image converted to markdown format ✅
Other Observations (not in diff)
File Line Issue
README.md -- The kilocode_change start/end block explaining the hidden .kilo npm artifact was removed. This was useful information for npm install users. Consider whether this should be preserved or intentionally dropped.
Files Reviewed (1 file)
  • README.md - 1 remaining issue, 1 resolved

Fix these issues in Kilo Cloud

Previous review (commit 2673ff9)

Status: 2 Issues Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 0
SUGGESTION 2
Issue Details (click to expand)

SUGGESTION

File Line Issue
README.md 9 npm badge uses different CDN and style (img.shields.io, flat-square) vs other badges (raster.shields.io, flat, height="20")
README.md 16 Hero image uses HTML <img> tag instead of markdown ![alt](url) format
Other Observations (not in diff)
File Line Issue
README.md -- The kilocode_change start/end block explaining the hidden .kilo npm artifact was removed. This was useful information for npm install users. Consider whether this should be preserved or intentionally dropped.
Files Reviewed (1 file)
  • README.md - 2 inline issues, 1 observation

Fix these issues in Kilo Cloud


Reviewed by deepseek-v4-pro-20260423 · 309,036 tokens

Review guidance: REVIEW.md from base branch main

Co-authored-by: kilo-code-bot[bot] <240665456+kilo-code-bot[bot]@users.noreply.github.com>
@bturcotte520
bturcotte520 merged commit 461c875 into main Jun 17, 2026
20 checks passed
@bturcotte520
bturcotte520 deleted the briant/updateREADME branch June 17, 2026 00:40
t7tran pushed a commit to t7tran/kilocode that referenced this pull request Aug 14, 2026
Revise README for improved clarity and details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants