Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tetzng committed Feb 4, 2025
1 parent 7dd1c28 commit 8a1d0db
Showing 1 changed file with 15 additions and 23 deletions.
38 changes: 15 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# open-github-url.nvim

**open-github-url.nvim** is a Neovim plugin to open the abbreviated GitHub repository URL under the cursor in your browser.
**open-github-url.nvim** is a Neovim plugin to open the abbreviated GitHub
repository URL under the cursor in your browser.

## Installation

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

```viml
Plug 'tetzng/open-github-url.nvim'
```

Using [dein](https://github.com/Shougo/dein.vim)

```viml
call dein#add('tetzng/open-github-url.nvim')
```

Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
[lazy.nvim](https://github.com/folke/lazy.nvim)

```lua
use 'tetzng/open-github-url.nvim'
{
"tetzng/open-github-url.nvim",

-- recommended
keys = {
{
"<leader>gh",
"<cmd>OpenGitHubUrlUnderCursor<cr>",
desc = "Open GitHub URL under cursor",
},
},
}
```

## Features
Expand All @@ -41,11 +41,3 @@ This command prints the repository path detected under the cursor.
Open a specific URL:
`:OpenUrl https://github.com/user/repo`
This command opens the given URL in the default web browser.

## Setup

To set up the plugin, simply call its `setup()` function, typically in your `init.lua` configuration file:
```lua
require('open-github-url').setup()
```
This will create the user commands described in the usage section.

0 comments on commit 8a1d0db

Please sign in to comment.