From 0033a6f3f160efdfe543471a5170e3321b014f3c Mon Sep 17 00:00:00 2001
From: Sonny Bakker <sonny871@hotmail.com>
Date: Mon, 9 Dec 2024 20:33:11 +0100
Subject: [PATCH] Update README

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9230bba..59c9203 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
 # source-link.lua
 
-View current file on configured git remote
\ No newline at end of file
+View the current line number of the current file on configured git remote.
+
+## Installation
+
+Call ``setup`` from your neovim configuration file:
+
+```lua
+...
+local source_link = require('source_link')
+
+source_link.setup()
+...
+
+```
+
+Optionally create a keybinding:
+
+```lua
+...
+local opts = { noremap = true, silent = true }
+
+vim.api.nvim_set_keymap('n', '<C-L>', '<cmd>:SourceOpen<CR>', opts)
+
+```
+
+Or call the command directly from Command mode: ``:SourceOpen``.