From eeccc54b761a4cc284ff3c58bf3b2e5960714882 Mon Sep 17 00:00:00 2001 From: max397574 Date: Fri, 22 Oct 2021 08:36:28 +0200 Subject: =?UTF-8?q?docs(readme):=20=F0=9F=93=9Aadded=20examples?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index eaa79e9..1621678 100644 --- a/readme.md +++ b/readme.md @@ -66,7 +66,7 @@ These themes are currently available: ### 🏗️The basic structure of the settings ```lua -** General structure of the settings ** +-- General structure of the settings settings = { section_1 =
-- as much sections as you like section_2 =
@@ -81,7 +81,7 @@ settings = { parts = {"section_1", "section_2"} -- all sections in order } -** Structure of a section ** +-- Structure of a section section = { type = , oldfiles_directory = true/false, @@ -163,3 +163,28 @@ command = , -- the amount of oldfiles to be displayed oldfiles_amount = , ``` +### Examples +
+ +Content for type = "text", table + +```lua +content = { + "This is:", + "Startup.nvim", + "by max397574" +} +``` +
+
+ +Content for type = "text", function + +```lua +content = function() + local clock = " " .. os.date "%H:%M" + local date = " " .. os.date "%d-%m-%y" + return {clock,date} +end +``` +
-- cgit v1.2.3