Skip to content

docs: rewrite README and close upstream #95/#191#244

Merged
barrettruth merged 2 commits into
canolafrom
docs/readme-canola-v2
Mar 21, 2026
Merged

docs: rewrite README and close upstream #95/#191#244
barrettruth merged 2 commits into
canolafrom
docs/readme-canola-v2

Conversation

@barrettruth
Copy link
Copy Markdown
Owner

Problem

README was still written as a drop-in oil.nvim replacement. Upstream tracker had a stale entry for stevearc#728 (deferred) and #95 still pointed to open #191.

Solution

Complete README rewrite as standalone canola product. Updated stevearc#728 to fixed (PR #83). Closed #191 (undo mutations — disproportionate complexity) and updated #95 to not actionable.

barrettruth and others added 2 commits March 21, 2026 00:00
Problem: the canola branch README was still written as a drop-in
oil.nvim replacement, referencing `require('oil').setup()` and
migration from stevearc/oil.nvim.

Solution: rewrite as a standalone product README. Features list
highlights canola-specific capabilities (virt_text columns, eza
highlights, custom column API, brace expansion, enhanced events).
Quick start section with keybinding table. Installation shows
`vim.g.canola` config pattern with no `setup()` call.
@barrettruth barrettruth merged commit 969194b into canola Mar 21, 2026
4 checks passed
@barrettruth barrettruth deleted the docs/readme-canola-v2 branch March 21, 2026 04:04
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