Skip to content

Commit 40136a0

Browse files
committed
add usage setion
1 parent 31f5ae1 commit 40136a0

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# archwiki-nvim
22

3-
Have any ArchWiki article available immediately.
3+
Have any ArchWiki article available instantly
44

55

66
## Dependencies
@@ -31,3 +31,15 @@ Plug 'Jackboxx/archwiki-nvim'
3131
dependencies = { 'nvim-telescope/telescope.nvim' }
3232
}
3333
```
34+
35+
## Usage
36+
```lua
37+
-- read page as plain text
38+
vim.keymap.set('n', '<leader>awp', '<cmd>lua require("archwiki.api").select_page_from_local()<cr>')
39+
-- read page as markdown
40+
vim.keymap.set('n', '<leader>awm', '<cmd>lua require("archwiki.api").select_page_from_local("-f markdown")<cr>')
41+
-- read page as html
42+
vim.keymap.set('n', '<leader>awh', '<cmd>lua require("archwiki.api").select_page_from_local("-f html")<cr>')
43+
-- update list of locally stored pages in a category
44+
vim.keymap.set('n', '<leader>awu', '<cmd>lua require("archwiki.api").update_category_from_local()<cr>')
45+
```

0 commit comments

Comments
 (0)