docs: modernize readme

This commit is contained in:
Barrett Ruth 2026-02-03 22:33:01 -05:00
parent c867f5efb7
commit d7d189a2e9

View file

@ -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