From ab3296ee85adbd4f7f208a5778d4ed6087a742b4 Mon Sep 17 00:00:00 2001
From: max397574 <max.heinzer397@gmx.ch>
Date: Mon, 18 Oct 2021 21:52:32 +0200
Subject: =?UTF-8?q?docs(readme):=20=F0=9F=93=9Astarted=20adding=20Customiz?=
 =?UTF-8?q?ation?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 readme.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 90c6a49..a1f1d01 100644
--- a/readme.md
+++ b/readme.md
@@ -7,16 +7,59 @@
 
 * Fully customizable
 * Themes
+* Easy Customization with building blocks
 
 📦Installation
 ------------
 Use your favourite package manager and call setup function.
+For the default setup telescope.nvim is a dependency.
 ```lua
+-- lua and packer.nvim
+
+use {
+  "max397574/startup.nvim",
+  requires = {"nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim"}
+  config = function()
+    require"startup".setup()
+  end
+}
 ```
 
 ⚙️Customization
 -------------
-Call the setup function with your configs
+<!-- NOTE: -->
+<!-- ???See wiki -->
+
+Call the setup function with your configurations
+
+It is recommended to use a file in the setup function. This can be done like this:
 
 ```lua
+-- lua and packer.nvim
+
+use {
+  "max397574/startup.nvim",
+  requires = {"nvim-telescope/telescope.nvim", "nvim-lua/plenary.nvim"}
+  config = function()
+    require"starup".setup(require"configs.startup") -- recommended to use a file for this
+  end
+}
 ```
+
+Here the file would be located at `/lua/configs/startup.lua`.
+The file has to return settings.
+
+For one of the default themes this can be done like this: (startify theme)
+
+```lua
+local settings = require"startup.themes.startify"
+
+return settings
+```
+<!-- NOTE: update this -->
+These themes are currently available:
+
+* Default
+* Startify
+<!-- TODO: evil-startup theme -->
+<!-- * Evil-startup -->
-- 
cgit v1.2.3