Skip to content
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

Jump to bottom

Improve readme #1

Merged
merged 1 commit into from
Oct 16, 2022
Merged

Improve readme #1

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
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const [anchor, setAnchor] = useState(null)

### Prerequisites

To use `nvim-rename-state`, since it makes use of [Neovim](https://github.com/neovim/neovim)'s built-in LSP, you will need to have installed [Neovim v0.5.0](https://github.com/neovim/neovim/releases/tag/v0.5.0) or [newer](https://github.com/neovim/neovim/releases/latest).
To use `nvim-rename-state`, since it makes use of [Neovim](https://github.com/neovim/neovim)'s built-in LSP, you will need to have installed [Neovim v0.5.0](https://github.com/neovim/neovim/releases/tag/v0.5.0) or [newer](https://github.com/neovim/neovim/releases/latest) and [treesitter](https://github.com/nvim-treesitter/nvim-treesitter).

### Installation

Expand All @@ -24,14 +24,28 @@ Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
'olrtg/nvim-rename-state',
branch = 'master'
branch = 'main'
}
```

Using [vim-plug](https://github.com/junegunn/vim-plug):

```viml
Plug 'olrtg/nvim-rename-state', { 'branch': 'master' }
Plug 'olrtg/nvim-rename-state', { 'branch': 'main' }
```

### Loading the plugin

Either in any lua file that gets loaded:

```lua
require'nvim-rename-state'.setup{}
```

Or in `init.vim`

```viml
lua require('nvim-rename-state')
```

## Contributing
Expand Down