Skip to content

Updated README.md #50

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
DrKJeff16 merged 1 commit into from
Aug 4, 2025
Merged

Updated README.md #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 7 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# wezterm-types

[Wezterm](https://github.com/wezterm/wezterm) config types for Lua Language Server
[Wezterm](https://github.com/wezterm/wezterm) config types for [Lua Language Server](https://luals.github.io/)

</div>

Expand All @@ -14,12 +14,11 @@

## Installation

For Neovim users, you can use the following install methods:
### Neovim

<details>
<summary><a href="https://github.com/folke/lazy.nvim">lazy.nvim</a></summary>
For [Neovim](https://github.com/neovim/neovim) users, we recommend the following install method.

Using `lazy.nvim` as a package manager, install this together with
Using [`lazy.nvim`](https://github.com/folke/lazy.nvim) as a package manager, install this together with
[`lazydev`](https://github.com/folke/lazydev.nvim):

```lua
Expand Down Expand Up @@ -68,8 +67,6 @@ require('lazy').setup({
}
```

</details>

---

## Usage
Expand All @@ -89,17 +86,15 @@ config.window_decorations = "RESIZE|MACOS_FORCE_DISABLE_SHADOW"
return config
```

This annotation enables the [Lua Language Server](https://luals.github.io/) to provide
This annotation enables the **Lua Language Server** to provide
proper type checking and autocompletion for WezTerm configuration options.

---

## Credits

- [@justinsgithub](https://github.com/justinsgithub) - **_The Author_**

- [@justinsgithub](https://github.com/justinsgithub) - **The Author _(not active currently)_**
- [@DrKJeff16](https://github.com/DrKJeff16) - **Maintainer, _de-facto_ Owner**
- [@gonstoll](https://github.com/gonstoll) - **Maintainer**
- [@DrKJeff16](https://github.com/DrKJeff16) - **Maintainer**

- [@craigmac](https://github.com/craigmac) - **Contributor**
- [@TheLeoP](https://github.com/TheLeoP) - **Contributor**