Skip to content

Commit 5b6bdd8

Browse files
committed
docs(readme): add badges
1 parent b92b02e commit 5b6bdd8

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ A terminal-based presentation tool that creates beautiful presentations from mar
1111
<div align="center">
1212
<img src="slideshow.gif" alt="slideshow" width=80%>
1313
</div>
14+
&nbsp;
15+
<div align="center">
16+
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/jesseduffield/lazygit">
17+
<img alt="Codacy Badge" src="https://api.codacy.com/project/badge/Grade/e4e6d3a8dc2a4614b40404f64d1d6e5f">
18+
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/museslabs/kyma/go.yml">
19+
<img alt="GitHub Tag" src="https://img.shields.io/github/v/tag/museslabs/kyma">
20+
</div>
1421

1522
## Features
1623

@@ -71,36 +78,47 @@ Kyma presentations use a simple format with slides separated by `----` and optio
7178

7279
```markdown
7380
# First Slide
81+
7482
This is the content of the first slide
7583

76-
----
7784
---
78-
transition: swipeLeft
85+
7986
---
8087

88+
## transition: swipeLeft
89+
8190
# Second Slide
91+
8292
This slide will appear with a swipe left transition
8393

84-
----
8594
---
95+
96+
---
97+
8698
transition: slideUp
8799
style:
88-
border: rounded
89-
border_color: "#9999CC"
90-
layout: center
91-
theme: dracula
100+
border: rounded
101+
border_color: "#9999CC"
102+
layout: center
103+
theme: dracula
104+
92105
---
93106

94107
# Third Slide
108+
95109
This slide has custom styling with Dracula theme
96110

97-
----
98111
---
112+
113+
---
114+
99115
style:
100-
theme: /path/to/custom-theme.json
116+
theme: /path/to/custom-theme.json
117+
101118
---
102119

103120
# Fourth Slide
121+
104122
This slide uses a custom JSON theme file
105123
```
106124

@@ -119,10 +137,10 @@ You can customize each slide's appearance using the style configuration:
119137

120138
```yaml
121139
style:
122-
border: rounded # Border style: normal, rounded, double, thick, hidden, block
123-
border_color: "#FF0000" # Hex color for border (or "default" for theme-based color)
124-
layout: center # Layout positioning: center, left, right, top, bottom
125-
theme: dracula # Theme name or path to custom JSON theme file
140+
border: rounded # Border style: normal, rounded, double, thick, hidden, block
141+
border_color: "#FF0000" # Hex color for border (or "default" for theme-based color)
142+
layout: center # Layout positioning: center, left, right, top, bottom
143+
theme: dracula # Theme name or path to custom JSON theme file
126144
```
127145
128146
Layout can also be specified as a combination: `layout: center,right`
@@ -231,6 +249,6 @@ All contributions are welcome! If you're planning a significant change or you're
231249
- Add support for more style options like text color and background color
232250
- ~~Allow choosing from any glamour themes~~ ✅ **Done!**
233251
- ~~Support for custom JSON theme files~~ ✅ **Done!**
234-
- Create grid-based slide layouts with transitions for each pane
252+
- Create grid-based slide layouts with transitions for each pane
235253
- Add more transition effects
236254
- Support image rendering in terminals (e.g., via the Kitty protocol)

0 commit comments

Comments
 (0)