add readme

This commit is contained in:
Yiyang Kang 2025-12-01 13:01:16 +09:00
parent 8411ddb147
commit ed567fdc17

25
README.md Normal file
View file

@ -0,0 +1,25 @@
# Usage
Load with `Lazy.nvim`
```lua
{
-- Neorg is still required because we need its code to complete the setup of
-- highlight groups.
"nvim-neorg/neorg",
version = "^9.0.0",
lazy = true,
config = nil,
},
{
url = "https://git.gensokyo.cafe/kkyy/neorg-migrate-tmp.git",
ft = "norg",
dependencies = {
"nvim-neorg/neorg",
},
config = function()
local norg_hl = require("neorg.modules.core.highlights.module")
norg_hl.public.trigger_highlights()
end,
},
```