docs: README

README.md

@@ -0,0 +1,74 @@
+# 💭👀precognition.nvim
+
+> /ˌpriːkɒɡˈnɪʃn/
+> _noun_
+>
+> 1. foreknowledge of an event, especially as a form of extrasensory perception.
+
+**precognition.nvim** is a nvim plugin for discovering motions (Both vertical and horizontal) to navigate your current buffer
+
+## 📦 Installation
+
+Installation with any package manager, Lazy example below:
+
+```lua
+
+return {
+    "tris203/precognition.nvim
+    config = {
+    -- startVisible = true,
+    -- hints = {
+    --     ["^"] = { text = "^", prio = 1 },
+    --     ["$"] = { text = "$", prio = 1 },
+    --     ["w"] = { text = "w", prio = 10 },
+    --     ["b"] = { text = "b", prio = 10 },
+    --     ["e"] = { text = "e", prio = 10 },
+    -- },
+    -- gutterHints = {
+    --     --prio is not currentlt used for gutter hints
+    --     ["G"] = { text = "G", prio = 1 },
+    --     ["gg"] = { text = "gg", prio = 1 },
+    --     ["{"] = { text = "{", prio = 1 },
+    --     ["}"] = { text = "}", prio = 1 },
+    -- },
+}
+```
+
+## ❔Usage
+
+### Toggling
+
+The hints can be toggled on and off with
+
+```
+:lua require("precognition").toggle()
+```
+
+### Peeking
+
+The hints can be peeked, this means that the hint will be show until the next
+cursor movement.
+
+```
+:lua require("precognition").peek()
+```
+
+## 💻 Supported Versions
+
+This plugin supports stable and nightly. >0.9 at the time of writing.
+
+## ✍️ Contributing
+
+Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion to improve the plugin, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+If there is something specific you want to work on then, please open an issue/discussion first to avoid duplication of efforts
+If you have found a bug please open an issue, or submit a PR with a failing test.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request