From efebbbcfdbaf4f4908025ef3d5c22dd03a6f0824 Mon Sep 17 00:00:00 2001 From: robin Date: Tue, 24 Mar 2026 11:09:38 +0100 Subject: [PATCH] doc: rewrite --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a6928c2..896a877 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,19 @@ tiny neovim session keeper, keeping your place safe ## :herb: what it does nivvie remembers where you left off and restores it when you return (session -handling). it keeps sessions stored safely and lets you call on them whenever -you need, without clutter or extra ritual. +handling). it keeps sessions stored safely and lets restore them whenever +you need, no configuration or extra steps needed. + +- automatic save and restore +- manual save, load, and delete commands +- minimal configuration +- lightweight and unobtrusive ## why nivvie there are larger session managers with more features. nivvie is a small and quiet companion, meant for when you want something clean, simple, and reliable. -## :sparkles: features - -- automatic save and restore (no extra steps) -- manual save, load, and delete commands (direct control) -- minimal configuration (defaults just work) -- lightweight and unobtrusive (stays out of the way) - ## :potted_plant: installation add nivvie with your favourite plugin manager. @@ -55,13 +53,13 @@ sessions are saved automatically when you quit neovim and restored when you open you may also map keys to these commands: ```lua -vim.keymap.set("n", "ss", ":NivvieSave") -vim.keymap.set("n", "sl", ":NivvieLoad") +vim.keymap.set("n", "ss", "Nivvie save") +vim.keymap.set("n", "sl", "Nivvie load") ``` ## :wilted_flower: configuration -nivvie works without configuration (zero setup). you can still adjust its behavior: +nivvie works without configuration but you can still adjust its behavior: ```lua require("nivvie").setup({ -- 2.51.2