From 72787806dfc0d773931ef6f639a6aefb41f5aadc Mon Sep 17 00:00:00 2001
From: nbr <nikolaus.brunner@protonmail.ch>
Date: Mon, 26 Aug 2024 22:10:05 +0200
Subject: [PATCH] docs(README): add installation instructions for lazy.nvim
 (DEV-160)

- docs(README): include code snippet for lazy.nvim installation
- fix(config): correct escaped plugin name in config.lua
---
 README.md                 | 17 +++++++++++++++++
 lua/black-atom/config.lua |  2 +-
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 72f01ded..5d9ce205 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,23 @@ This is all a work in progress.
 
 ---
 
+## Installation
+
+Install the plugin with your favourite package manager. 
+Example with [lazy.nvim](https://github.com/folke/lazy.nvim):
+
+```lua
+---@type LazyPluginSpec
+return {
+    "black-atom-industries/nvim",
+    name = "black-atom",
+    priority = 1000,
+    ---@module "black-atom"
+    ---@type BlackAtom.Config
+    opts = {},
+}
+```
+
 ## Development
 
 ### Linting
diff --git a/lua/black-atom/config.lua b/lua/black-atom/config.lua
index b9f81dd2..cdaa4f36 100644
--- a/lua/black-atom/config.lua
+++ b/lua/black-atom/config.lua
@@ -1,7 +1,7 @@
 local M = {}
 
 -- Escaped plugin name. Used to find its own installation path.
-M.plugin_name = "black%-atom%.nvim"
+M.plugin_name = "black%-atom"
 
 ---@type BlackAtom.Config
 M.default = {