From 709c87b8799f4aaa51ca8c90a2e5240bb6b04198 Mon Sep 17 00:00:00 2001 From: Gustaf Rydholm Date: Thu, 24 Oct 2024 23:30:12 +0200 Subject: Add install instructions --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.md b/README.md index 90dd84d..c46ed6f 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,50 @@ require("no-clown-fiesta").setup({ }) ``` +### Installation + +If you are using the lazy, then you can install and configure the plugin like this: + +```fnl +(local opts {:styles {:type {:bold true} + :lsp {:undercurl false} + :match_paren {:underline true}}}) + +(λ config [] + (let [plugin (require :no-clown-fiesta)] + (plugin.setup opts) + (plugin.load))) + +{1 :aktersnurra/no-clown-fiesta.nvim :lazy false :priority 1000 : config} +``` + +or if you prefer lua: + +```lua +local opts = { + styles = { + type = { bold = true }, + lsp = { underline = false }, + match_paren = { underline = true }, + }, +} + +local function config() + local plugin = require "no-clown-fiesta" + plugin.setup(opts) + return plugin.load() +end + +return { + "aktersnurra/no-clown-fiesta.nvim", + priority = 1000, + config = config, + lazy = false, +} +``` + +Other plugin managers are left as an exercise to the reader. + ## Supported Plugins - Alpha -- cgit v1.2.3-70-g09d2