From 298fa387c88672ef7b826e75c86e50b347f3f2d8 Mon Sep 17 00:00:00 2001 From: Maximilian Friedersdorff Date: Tue, 22 Oct 2024 10:16:45 +0100 Subject: [PATCH] Fix the documentation somewhat --- README.md | 40 ++++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index f6b4738..d71de28 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,22 @@ # openingh.nvim -Opens the current file or project page in GitHub. + +Opens the current file or project page in the web interface of the remote. ![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua) -![GitHub release (latest by date)](https://img.shields.io/github/v/release/almo7aya/openingh.nvim?style=for-the-badge) -[![lint with luacheck](https://img.shields.io/github/actions/workflow/status/almo7aya/openingh.nvim/lint.yml?style=for-the-badge)](https://github.com/Almo7aya/openingh.nvim/actions/workflows/lint.yml) -![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/almo7aya/openingh.nvim/ci.yml?label=TESTS&style=for-the-badge) +- Features + - Supports macOS, Linux, Windows and WSL + - Works with detached HEAD and supports checked out branches or forks + - Automatically selects the correct line number on the file page + - Supports GitHub, GitHub Enterprise, GitLab, and Bitbucket - - Features - - Supports macOS, Linux, Windows and WSL - - Works with detached HEAD and supports checked out branches or forks - - Automatically selects the correct line number on the file page - - Supports GitHub, GitHub Enterprise, GitLab, and Bitbucket - - - Demo +- Demo ![](./gifs/demo.gif) ## Requirements - - Neovim 0.7.2+ +- Neovim 0.7.2+ ## Installation @@ -30,21 +27,21 @@ Opens the current file or project page in GitHub. ```lua -- init.lua require("packer").startup(function() - use "almo7aya/openingh.nvim" + use "https://gitea.gwairfelin.com/max/openingh.nvim" end) ``` ## Commands - `:OpenInGHRepo` - - Opens the project's git repository page in GitHub. + - Opens the project's git repository page in the remote. - `:OpenInGHFile` - - Opens the current file page in GitHub. This command supports ranges. + - Opens the current file page in the remote. - `:OpenInGHFileLines` - - Opens the current file page in GitHub. This command supports ranges. - + - Opens the current file page in the remote, with the lines highlighted. This + command supports ranges. ## Registers @@ -77,15 +74,14 @@ vim.api.nvim_set_keymap("v", "gf", ":OpenInGHFileLines ", { silent = ## TODO - - [x] Support the current file cursor position - - [x] Support visual mode to open a file in range selection - - [x] Support other version control websites +- [x] Support the current file cursor position +- [x] Support visual mode to open a file in range selection +- [x] Support other version control websites ## Contribution -Feel free to open an issue or a pull request if you have any suggestions or improvements +Feel free to open an issue or a pull request if you have any suggestions or improvements ## License [MIT](./LICENSE) -