docs: usage instructions; license

README.md

@@ -0,0 +1,55 @@
+# syntax-gaslighting.nvim
+
+Gaslighting? That's not even a real word, you're crazy.
+
+## Usage
+
+Use what?
+
+Install with your favorite package manager (or Nix), then call the `setup`
+function.
+
+```lua
+require("syntax-gaslighting").setup()
+```
+
+## Example Configuration
+
+```lua
+require("syntax-gaslighting").setup({
+  -- Set the chance of gaslighting per line (1-100%)
+  gaslighting_chance = 5,  -- Default is 5%
+
+  -- Minimum line length to apply gaslighting
+  min_line_length = 10,    -- Default is 10 characters
+
+  -- Custom messages for gaslighting (optional)
+  messages = {
+    "Are you sure this will pass the code quality checks? 🤔",
+    "Is this line really covered by unit tests? 🧐",
+    -- Add more custom messages here...
+  },
+
+  -- Option to merge user messages with the default ones (default: false)
+  merge_messages = true,    -- Default is false
+
+  -- Highlight group for gaslighting messages (linked to Comment by default)
+  highlight = "GaslightingUnderline",
+
+  -- Debounce delay for updates in milliseconds (default: 500ms)
+  debounce_delay = 500,
+
+  -- Auto-update on buffer events (default: true)
+  auto_update = true,
+
+  -- List of filetypes to ignore (default: {"netrw"})
+  filetypes_to_ignore = { "netrw", "markdown" },  -- Add filetypes to ignore here
+})
+```
+
+## License
+
+Based on the awesome
+[VSCode extension](https://github.com/eNiiju/syntax-gaslighting) from
+[@eNiiju](https://github.com/eNiiju). To remain compatible with the license,
+syntax-gaslighting.nvim is licensed under the [MPL](./LICENSE)