Skip to content

docs(readme): add a competitor comparison section#44

Merged
BlackHole1 merged 1 commit into
mainfrom
docs/readme-comparison
Jun 30, 2026
Merged

docs(readme): add a competitor comparison section#44
BlackHole1 merged 1 commit into
mainfrom
docs/readme-comparison

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

Adds a Comparison section to the README that benchmarks LockIME against the two most widely-used alternatives — Input Source Pro (~3.3k★) and KeyboardHolder (~1.6k★) — with a feature table, a short note on the smaller open-source/CLI tools (SwitchKey, Kawa, InputSwitcher, macism), and an honest "where LockIME fits" paragraph that recommends the competitors for their real strengths.

The competitor facts weren't guessed: download sizes, URL match types, settings backup, the permission model, and localization were gathered from each project and cross-checked against its current release, so the table reflects Input Source Pro 2.11.0 and KeyboardHolder 1.14.10. The framing is deliberately fair — it shows where LockIME loses (higher macOS floor, no on-screen input hints) as well as where it genuinely differs (continuous re-lock, per-rule lock-or-switch, an address-bar rule, richer lockime:// automation, the broadest localization, and a sub-3 MB download).

Per the README i18n rule, the section ships in every SupportedLanguage: the authoritative English at the repo root plus the eight translations under docs/README/, kept row-for-row in sync — same table structure, with brand names, symbols, code, and URLs identical across languages.

Reviewer note: the only fact not directly documented by the vendors is that Input Source Pro's core (global/per-app) works without Accessibility — a reasonable inference from how the feature works, presented in the table as parity with LockIME rather than a LockIME advantage.

Add a Comparison section to the README benchmarking LockIME against the
two most widely-used alternatives — Input Source Pro and KeyboardHolder —
with a feature table, a short list of other tools (SwitchKey, Kawa,
InputSwitcher, macism), and an honest "where LockIME fits" note. It gives
prospective users a fair side-by-side and records where LockIME genuinely
differs: a continuous re-lock, per-rule lock-or-switch, an address-bar
rule, richer `lockime://` automation, the broadest localization, and a
sub-3 MB download.

Competitor facts — download sizes, URL match types, settings backup,
permission model, localization — were gathered and cross-checked against
each project's current release, so the table reflects Input Source Pro
2.11.0 and KeyboardHolder 1.14.10 rather than stale figures.

Per the README i18n rule, the section ships in every SupportedLanguage:
the authoritative English at the repo root and the translations under
docs/README/, kept row-for-row in sync.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9a04715b-3737-461a-a1ec-3856be6291f9

📥 Commits

Reviewing files that changed from the base of the PR and between f060886 and 77bbeb4.

📒 Files selected for processing (9)
  • README.md
  • docs/README/README.de.md
  • docs/README/README.es.md
  • docs/README/README.fr.md
  • docs/README/README.ja.md
  • docs/README/README.pt.md
  • docs/README/README.ru.md
  • docs/README/README.zh-CN.md
  • docs/README/README.zh-TW.md

Summary by CodeRabbit

  • Documentation
    • Added a new “Comparison” section to the README in multiple languages.
    • Included side-by-side comparisons with similar tools, covering features like rules, shortcuts, logging, backups, automation, permissions, and update status.
    • Added brief guidance on when LockIME is the best fit and notes clarifying that the comparison numbers are approximate.

Walkthrough

A new Comparison section is added to README.md and all nine localized README files (de, es, fr, ja, pt, ru, zh-CN, zh-TW). Each file receives narrative text describing LockIME's continuous re-locking approach versus Input Source Pro and KeyboardHolder, a multi-row feature comparison table, a list of other related tools, a "where LockIME fits" guidance paragraph, and a footnote clarifying that figures are approximate and collected mid-2026.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required format and clearly summarizes the README comparison section changes.
Description check ✅ Passed The description is directly related to the README comparison updates and aligns with the changeset.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/readme-comparison

Comment @coderabbitai help to get the list of available commands.

@BlackHole1 BlackHole1 merged commit c7e61e8 into main Jun 30, 2026
3 checks passed
@BlackHole1 BlackHole1 deleted the docs/readme-comparison branch June 30, 2026 04:20
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.

1 participant