init: Creation of the plugin skeleton

2026-06-01 07:07:25 -05:00
commit 6309ef52d4
4 changed files with 29 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,19 @@
+# FaultyNotes (title WIP)
+
+A custom and pared down note taking plugin for the Neovim editor (targetting v0.12+) based on the Zettelkasten style, built to rely upon Neovim native functionality and minimal optional additions (such as Telescope integration).
+
+## Installation
+
+### vim.pack
+
+```lua
+vim.pack.add({
+    'https://git.faultybranches.dev/FaultyBranches_Public/faultynotes.git'
+})
+```
+
+## Init and Configuration
+
+```lua
+require('faultynotes').setup()
+```