From fc78b4e9b0fd1f2f68beb40eddadc583572b083d Mon Sep 17 00:00:00 2001 From: Ethan Smith-Coss Date: Sun, 12 Mar 2023 13:08:42 +0000 Subject: [PATCH] Update 'README.md' Signed-off-by: Ethan Smith-Coss --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a1d69c..aca7b97 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ # template.nvim +A template repository for Neovim extensions written in Lua. -A template repository for Neovim extensions written in Lua. \ No newline at end of file +## Purpose of Template +Simplify the process of creating a new extensions for Neovim by starting from a template to ensure that your project +workspace is coherent across projects. + +This repository is designed to be compliant with wrapping an extension to be used by other plugins, such as Packer. +Thus, changing the general structure of the template might break compliance. However the project is to be structured +10 internally is the decision of the developer. \ No newline at end of file