From 24b88a0483f4195b5c6b8a5ac1148dd5c0dc0949 Mon Sep 17 00:00:00 2001
From: TorchedSammy <38820196+TorchedSammy@users.noreply.github.com>
Date: Thu, 17 Mar 2022 20:25:38 -0400
Subject: [PATCH] docs: add docs for vim mode

---
 docs/vimMode/actions.txt | 16 ++++++++++++++++
 docs/vimMode/index.txt   |  4 ++++
 2 files changed, 20 insertions(+)
 create mode 100644 docs/vimMode/actions.txt
 create mode 100644 docs/vimMode/index.txt

diff --git a/docs/vimMode/actions.txt b/docs/vimMode/actions.txt
new file mode 100644
index 0000000..9dfb7b2
--- /dev/null
+++ b/docs/vimMode/actions.txt
@@ -0,0 +1,16 @@
+Vim actions are essentially just when a user uses a Vim keybind.
+Things like yanking and pasting are Vim actions.
+This is not an "offical Vim thing," just a Hilbish thing.
+
+The `hilbish.vimAction` hook is thrown whenever a Vim action occurs.
+It passes 2 arguments: the action name, and an array (table) of args
+relating to it.
+
+Here is documentation for what the table of args will hold for an
+appropriate Vim action.
+
+- `yank`: register, yankedText
+The first argument for the yank action is the register yankedText goes to.
+
+- `paste`: register, pastedText
+The first argument for the paste action is the register pastedText is taken from.
diff --git a/docs/vimMode/index.txt b/docs/vimMode/index.txt
new file mode 100644
index 0000000..a30fe74
--- /dev/null
+++ b/docs/vimMode/index.txt
@@ -0,0 +1,4 @@
+Hilbish has a Vim binding input mode accessible for use.
+It can be enabled with the `hilbish.inputMode` function (check `doc hilbish`).
+
+This is documentation for everything relating to it.