From 49a7354a5f60ba00d5329fd93232d1737c290f05 Mon Sep 17 00:00:00 2001
From: Wassim Metallaoui <wassim@metallaoui.com>
Date: Sun, 26 May 2024 19:07:22 -0500
Subject: [PATCH] docs: update the README to good enough for v0.1.0

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9a09ee0..f59da43 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,57 @@
 # gh-navigator.nvim
-Quickly navigate from Neovim to GitHub with this plugin
+
+This Neovim plugin makes jumping from coding to GitHub as painless as possible.
+
+## Setup
+
+### Prerequisites
+
+The plugin is mostly a wrapper around the [GitHub CLI](https://cli.github.com/), `gh`, with a few direct calls to `git`. So ensure the `gh` tool is installed and can connect to your GitHub account.
+
+An example of how to setup `gh` for a macOS user is:
+
+```shell
+brew install cli
+gh auth login
+```
+
+If you already have the `gh` tool installed, ensure it's working:
+```shell
+gh auth status
+```
+
+### Installation
+
+Install **gh-navigator** using your plugin manager of choice. For example, here it is using [lazy.nvim](https://github.com/folke/lazy.nvim).
+
+```lua
+{
+  'wassimk/gh-navigator.nvim',
+  cmd = { 'GH', 'GHBlame', 'GHFile', 'GHPR', 'GHRepo' },
+  version = "*",
+  config = true
+}
+```
+
+Specifying the `cmd` will lazy load the plugin when you first use one of the commands.
+
+I'll also be actively working off the `main` branch, so use versioned releases with the `version` key to avoid unexpected breaking changes.
+
+### Commands
+
+| Command | Description |
+|---------|:------------|
+| `GH` | Heuristically open commit sha or PR using number or search term(s) |
+| `GHBlame` | Open the current file in blame view |
+| `GHFile` | Open the current file in blob view |
+| `GHPR` | Open PR by commit SHA, PR number, or search term(s) |
+| `GHRepo` | Open the current repo |
+
+### Usage
+
+Move the cursor over a sha, pr number, or word and execute the commands. The word under the cursor will be the argument.
+
+You can also call them with an argument. `:GHPR 1234` or `:GHPR [c2d25b3]`.
+
+Most commands accept a range. For example, highlight the lines you want to blame and execute `:GHBlame`.
+