diff --git a/Readme.md b/Readme.md index 700d104..fc418db 100644 --- a/Readme.md +++ b/Readme.md @@ -5,3 +5,17 @@ Remap for the bepo layout in Lua, inspired from https://github.com/michamos/vim-bepo It aims to be faster (takes only 0.4ms at startup on my machine, while vim-bepo requires 1.6ms) + +## Example Use Case + +``` lua +require("bepo").setup() +``` + +You can also apply only some mapping groups: +``` lua +require("bepo").movement() +require("bepo").tabs() +require("bepo").easy_access() +require("bepo").window() +``` diff --git a/fnl/bepo.fnl b/fnl/bepo.fnl index fb5e716..5c8980a 100644 --- a/fnl/bepo.fnl +++ b/fnl/bepo.fnl @@ -137,8 +137,8 @@ (set vim.g.loaded_bepo_nvim 1))) {: setup - :mapping_movement mapping-movement - :mapping_tabs mapping-tabs - :mapping_easy_access mapping-easy-access - :mapping_window mapping-window} + :movement mapping-movement + :tabs mapping-tabs + :easy_access mapping-easy-access + :window mapping-window} diff --git a/lua/bepo.lua b/lua/bepo.lua index 8a5cee8..60680d6 100644 --- a/lua/bepo.lua +++ b/lua/bepo.lua @@ -81,4 +81,4 @@ local function setup() return nil end end -return {setup = setup, mapping_movement = mapping_movement, mapping_tabs = mapping_tabs, mapping_easy_access = mapping_easy_access, mapping_window = mapping_window} +return {setup = setup, movement = mapping_movement, tabs = mapping_tabs, easy_access = mapping_easy_access, window = mapping_window}