From 82a8f01fe11d6ee6c33b5e7dc96d97aec426b466 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= <nicolas@ortegas.org>
Date: Fri, 10 Jul 2026 16:17:51 +0200
Subject: [PATCH] Expand README with installation and configuration
 instructions

Add comprehensive installation section covering:
- Manual installation for Vim and NeoVim
- Plugin manager installations:
  - vim-plug
  - packer.nvim
  - lazy.nvim
  - dein.vim
  - Vundle

Add configuration section for setting g:licenser_author.

Add sections documenting:
- All supported licenses
- All supported file types
- Reference to :help licenser

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
 README.md | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 116 insertions(+)

diff --git a/README.md b/README.md
index 5b1be0e..5bd4241 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,78 @@
 A plugin for Vim and NeoVim that helps you add license headers to your source
 code files.
 
+## Installation
+
+### Manual Installation
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/naortega/vim-licenser.git
+   ```
+
+2. Copy the plugin files to your Vim/NeoVim configuration directory:
+
+   ```bash
+   cp -r vim-licenser/plugin/* ~/.vim/plugin/
+   cp -r vim-licenser/doc/* ~/.vim/doc/
+   cp -r vim-licenser/licenses/* ~/.vim/licenses/
+   ```
+
+For NeoVim, use `~/.config/nvim/` instead of `~/.vim/`.
+
+### Using vim-plug
+
+Add the following to your `init.vim` or `.vimrc`:
+
+```vim
+Plug 'naortega/vim-licenser'
+```
+
+Then run `:PlugInstall` in Vim/NeoVim.
+
+### Using packer.nvim
+
+Add the following to your `init.lua`:
+
+```lua
+use 'naortega/vim-licenser'
+```
+
+Then run `:PackerSync` in NeoVim.
+
+### Using lazy.nvim
+
+Add the following to your `init.lua`:
+
+```lua
+{
+  'naortega/vim-licenser',
+  lazy = true,
+  cmd = 'Licenser',
+}
+```
+
+### Using dein.vim
+
+Add the following to your `init.vim`:
+
+```vim
+call dein#add('naortega/vim-licenser')
+```
+
+Then run `:call dein#install()` in Vim/NeoVim.
+
+### Using Vundle
+
+Add the following to your `.vimrc`:
+
+```vim
+Plugin 'naortega/vim-licenser'
+```
+
+Then run `:PluginInstall` in Vim.
+
 ## Usage
 
 You can add a license header to your source file by running the following
@@ -12,6 +84,50 @@ command in Vim or NeoVim:
 :Licenser <license>
 ```
 
+### Configuration
+
+Set your author name in your `init.vim` or `.vimrc`:
+
+```vim
+let g:licenser_author = "Your Name"
+```
+
+For NeoVim with `init.lua`:
+
+```lua
+vim.g.licenser_author = "Your Name"
+```
+
+### Supported Licenses
+
+vim-licenser includes templates for the following licenses:
+
+- AGPL (GNU Affero General Public License v3)
+- Apache2 (Apache License 2.0)
+- BSD2 (BSD 2-Clause License)
+- BSD3 (BSD 3-Clause License)
+- GPL (GNU General Public License v3)
+- GPLv2 (GNU General Public License v2)
+- ISC (ISC License)
+- LGPL (GNU Lesser General Public License v3)
+- MIT (MIT License)
+- MIT0 (MIT No Attribution License)
+- MPL2 (Mozilla Public License v2.0)
+- Unlicense (public domain)
+- Zlib (Zlib License)
+
+Use tab completion to see all available licenses: `:Licenser <TAB>`
+
+### Supported File Types
+
+vim-licenser automatically detects your file type and applies the appropriate
+comment style. Supported file types include:
+bash, c, cpp, csharp, css, dart, go, groovy, haskell, html, java, javascript,
+json, kotlin, lua, matlab, perl, php, python, r, ruby, rust, scala, shell, sql,
+swift, typescript, typescriptreact, vim, xml, yaml
+
+For more information, see `:help licenser` after installation.
+
 ## Adding New Licenses
 
 To add a new license, create a new file in the `licenses` directory with the