docs: minimal readme, rockspec copy_directories, luarocks workflow #19

Merged

barrettruth merged 2 commits from docs/readme-rocks into main

2026-03-20 22:39:28 +00:00

barrettruth commented

2026-03-20 22:38:10 +00:00

Problem

The README was verbose with an inline Configuration section and a
lazy-loading note that duplicate the docs. canola-git was listed as
an adapter instead of an extension. The rockspec build section lacked
copy_directories, so doc/ and plugin/ were excluded from the
luarocks package.

Solution

Rewrite the README to the minimal style: intro, adapter/extension
tables, brief Installation (including luarocks install), and a
Documentation section. Move canola-git to Extensions. Add
copy_directories = { 'doc', 'plugin' } to the rockspec build
table.

Closes #7
Closes #8

## Problem The README was verbose with an inline Configuration section and a lazy-loading note that duplicate the docs. `canola-git` was listed as an adapter instead of an extension. The rockspec `build` section lacked `copy_directories`, so `doc/` and `plugin/` were excluded from the luarocks package. ## Solution Rewrite the README to the minimal style: intro, adapter/extension tables, brief Installation (including `luarocks install`), and a Documentation section. Move `canola-git` to Extensions. Add `copy_directories = { 'doc', 'plugin' }` to the rockspec `build` table. Closes #7 Closes #8