aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormax397574 <[email protected]>2021-10-22 08:36:28 +0200
committermax397574 <[email protected]>2021-10-22 08:36:28 +0200
commiteeccc54b761a4cc284ff3c58bf3b2e5960714882 (patch)
tree3a40b5ba0032fdc402734072f1806e19f86a9c08
parent2d89bca094726b9dd4e289ac6bda367d58cf07c9 (diff)
docs(readme): 📚added examples
-rw-r--r--readme.md29
1 files changed, 27 insertions, 2 deletions
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 = <section> -- as much sections as you like
section_2 = <section>
@@ -81,7 +81,7 @@ settings = {
parts = {"section_1", "section_2"} -- all sections in order
}
-** Structure of a section **
+-- Structure of a section
section = {
type = <type>,
oldfiles_directory = true/false,
@@ -163,3 +163,28 @@ command = <command>,
-- the amount of oldfiles to be displayed
oldfiles_amount = <amount>,
```
+### Examples
+<details>
+<summary>
+Content for type = "text", table
+</summary>
+```lua
+content = {
+ "This is:",
+ "Startup.nvim",
+ "by max397574"
+}
+```
+</details>
+<details>
+<summary>
+Content for type = "text", function
+</summary>
+```lua
+content = function()
+ local clock = " " .. os.date "%H:%M"
+ local date = " " .. os.date "%d-%m-%y"
+ return {clock,date}
+end
+```
+</details>