pending.nvim/README.md
Barrett Ruth bc2a106617 docs: update vimdoc for sync refactor, remove demo scripts
Problem: Docs still referenced openssl dependency, defaulting to `sync`
action, and the `calendar` config field. Demo scripts used the old
singleton `store` API.

Solution: Update vimdoc and README to reflect explicit actions, per-
category calendars, and pure-Lua PKCE. Remove stale demo scripts and
update sync specs to match new behavior.
2026-03-05 11:24:43 -05:00

46 lines
910 B
Markdown

# pending.nvim
Edit tasks like text. `:w` saves them.
![demo](assets/demo.gif)
## Requirements
- Neovim 0.10+
- (Optionally) `curl` for Google Calendar and Google Task sync
## Installation
Install with your package manager of choice or via
[luarocks](https://luarocks.org/modules/barrettruth/pending.nvim):
```
luarocks install pending.nvim
```
## Documentation
```vim
:help pending.nvim
```
## Icons
All display characters are configurable. Defaults produce markdown-style checkboxes (`[ ]`, `[x]`, `[!]`):
```lua
vim.g.pending = {
icons = {
pending = ' ', done = 'x', priority = '!',
due = '.', recur = '~', category = '#',
},
}
```
See `:help pending.Icons` for nerd font examples.
## Acknowledgements
- [dooing](https://github.com/atiladefreitas/dooing)
- [todo-comments.nvim](https://github.com/folke/todo-comments.nvim)
- [todotxt.nvim](https://github.com/arnarg/todotxt.nvim)