From d947d5a5dfaefdbd7ffd0d30bb41a7fee7b58039 Mon Sep 17 00:00:00 2001
From: edluffy <edward@ncade.com>
Date: Sun, 14 Mar 2021 19:34:19 +0000
Subject: [PATCH] Update README.md

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 110ee96..29b216c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,28 @@
-# specs.nvim
+# specs.nvim 👓
+Specs.nvim - show where your cursor moves when jumping large distances (e.g between windows). Fast and lightweight, written completely in Lua.
+
+## Install
+Using [packer.nvim](https://github.com/wbthomason/packer.nvim):
+```lua
+use {'edluffy/specs.nvim'}
+```
+Using [vim-plug](https://github.com/junegunn/vim-plug):
+```vimscript
+Plug 'edluffy/specs.nvim'
+```
+## Usage
+If you are using init.vim instead of init.lua, remember to wrap block below with `lua << EOF` and `EOF`
+```
+require('specs').setup{ 
+    show_jumps  = true,
+    min_jump = 30,
+    popup = {
+        delay_ms = 0, 
+        inc_ms = 10,
+        blend = 10,
+        width = 10,
+        fader = require('specs').linear_fader,
+        resizer = require('specs').shrink_resizer
+    }
+}
+```