From d7d189a2e9f3a64079b7ac0796ba5a2ce2e8a5b7 Mon Sep 17 00:00:00 2001 From: Barrett Ruth Date: Tue, 3 Feb 2026 22:33:01 -0500 Subject: [PATCH] docs: modernize readme --- readme.md | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) diff --git a/readme.md b/readme.md index da1f1ec..75b160f 100644 --- a/readme.md +++ b/readme.md @@ -5,7 +5,7 @@ Live reload HTML, CSS, and JavaScript files inside Neovim with the power of ## Installation -Install using your package manager of choice or via +Install with your package manager or via [luarocks](https://luarocks.org/modules/barrettruth/live-server.nvim): ``` @@ -14,30 +14,7 @@ luarocks install live-server.nvim ## Dependencies -- [live-server](https://www.npmjs.com/package/live-server) (install globally via - npm/pnpm/yarn) - -## Configuration - -Configure via `vim.g.live_server` before the plugin loads: - -```lua -vim.g.live_server = { - args = { '--port=5555' }, -} -``` - -See `:help live-server` for available options. - -## Usage - -```vim -:LiveServerStart [dir] " Start the server -:LiveServerStop [dir] " Stop the server -:LiveServerToggle [dir] " Toggle the server -``` - -The server runs by default on `http://localhost:5555`. +- [live-server](https://www.npmjs.com/package/live-server) (install globally via npm/yarn) ## Documentation