Skip to content

Commit 363a9f6

Browse files
committed
docs: Update README for OpenFeature branding and theme installation instructions
Signed-off-by: André Silva <2493377+askpt@users.noreply.github.com>
1 parent 6fae128 commit 363a9f6

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,15 @@
1-
# slidev-theme-open-feature
1+
# OpenFeature Slidev Theme
22

3-
[![NPM version](https://img.shields.io/npm/v/slidev-theme-open-feature?color=3AB9D4&label=)](https://www.npmjs.com/package/slidev-theme-open-feature)
3+
[![NPM version](https://img.shields.io/npm/v/@openfeature/slidev-theme-open-feature?color=3AB9D4&label=)](https://www.npmjs.com/package/@openfeature/slidev-theme-open-feature)
44

5-
A (...) theme for [Slidev](https://github.com/slidevjs/slidev).
6-
7-
<!--
8-
Learn more about how to write a theme:
9-
https://sli.dev/guide/write-theme.html
10-
--->
11-
12-
<!--
13-
run `npm run dev` to check out the slides for more details of how to start writing a theme
14-
-->
15-
16-
<!--
17-
Put some screenshots here to demonstrate your theme
18-
19-
Live demo: [...]
20-
-->
5+
An [OpenFeature](https://openfeature.dev)-branded theme for [Slidev](https://github.com/slidevjs/slidev). It features the official OpenFeature color palette, wave-style background decorations, and Poppins / Architects Daughter typography — with full support for light and dark mode.
216

227
## Install
238

249
Add the following frontmatter to your `slides.md`. Start Slidev then it will prompt you to install the theme automatically.
2510

2611
<pre><code>---
27-
theme: <b>open-feature</b>
12+
theme: <b>@openfeature/slidev-theme-open-feature</b>
2813
---</code></pre>
2914

3015
Learn more about [how to use a theme](https://sli.dev/guide/theme-addon#use-theme).
@@ -33,7 +18,16 @@ Learn more about [how to use a theme](https://sli.dev/guide/theme-addon#use-them
3318

3419
This theme provides the following layouts:
3520

36-
> TODO:
21+
| Layout | Description |
22+
|--------|-------------|
23+
| `cover` | Title slide with centered content and prominent wave background |
24+
| `default` | Standard content slide with a title bar and body area |
25+
| `end` | Closing slide with centered content and prominent wave background |
26+
| `image-left` | Two-column layout with an image on the left (`image` prop required) |
27+
| `image-right` | Two-column layout with an image on the right (`image` prop required) |
28+
| `intro` | Introduction / about slide with centered content |
29+
| `section` | Section divider with large centered heading |
30+
| `two-cols` | Two-column layout using default and `::right::` slots |
3731

3832
## Components
3933

@@ -48,3 +42,5 @@ This theme provides the following components:
4842
- Edit the `example.md` and style to see the changes
4943
- `npm run export` to generate the preview PDF
5044
- `npm run screenshot` to generate the preview PNG
45+
46+
> **Note:** Node.js >= 18 is required. The repo includes an `.nvmrc` (Node 22) — run `nvm use` to pick it up.

0 commit comments

Comments
 (0)