Skip to content

Updates documentation with lazy config and vim notify information #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmmulroy merged 2 commits into from
Nov 12, 2025
Merged

Updates documentation with lazy config and vim notify information #70

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
490abc6
docs: add lazy info
NigelGreenway Sep 25, 2025
e549b4b
docs: move and update vim-notify info
NigelGreenway Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,23 @@ use('dmmulroy/tsc.nvim')

```

### Lazy

To install the plugin using lazy.nvim, add the following to your plugin configuration:

```lua
-- tsc.lua
return {
"dmmulroy/tsc.nvim",
config = function()
require("tsc").setup({
-- Your config here
})
end,
}

```

### Vim-Plug

To install the plugin using vim-plug, add the following to your plugin configuration:
Expand All @@ -50,12 +67,14 @@ Plug 'dmmulroy/tsc.nvim'

Then run `:PlugInstall` to install the plugin.

### Notify

For an enhanced UI/UX experience, it is recommended to install the [nvim_notify](https://github.com/rcarriga/nvim-notify) plugin as well. This plugin is optional, and the plugin will work without it.

## Setup

> **Notifications**
>
> For an enhanced UI/UX experience, it is recommended to install the [nvim_notify](https://github.com/rcarriga/nvim-notify) plugin as well. This plugin is optional, and the plugin will work without it.
>
> For this plugin to work with vim-notify, you will need to ensure that `vim.notify = require("notify")` has been added to your NeoVim configuration

To set up the plugin, add the following line to your `init.vim` or `init.lua` file:

```lua
Expand Down
Loading