Skip to content

Commit b41a2c5

Browse files
committed
Clarify installation requirements and appearance options
1 parent 33ad430 commit b41a2c5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ View sample at https://cdlib.github.io/klaro-ui
66

77
## Requirements
88

9-
- Git
109
- Node version 20 or above
1110
- NPM version 10 or above
12-
- Klaro source and a valid config file
11+
- Klaro source script and config file
12+
- Modifying the loading of third-party scripts in your application's HTML
1313

1414
## Installation
1515

16-
1. Follow the steps in [Getting Started](https://klaro.org/docs/getting-started) within the Klaro documentation.
16+
1. Follow the steps in [Getting Started](https://klaro.org/docs/getting-started) within the Klaro documentation. You can use the [example Klaro config](https://github.com/cdlib/klaro-ui/blob/main/js/klaro-config.js) in this repo as a boilerplate for your Klaro instance.
1717

1818
2. Within the `src` URL of the Klaro script (after the config script), replace the URL ending in **klaro.js** with the "no CSS" version:
1919

@@ -39,7 +39,7 @@ The module **klaro-ui** is now installed in your application's **node_modules**
3939

4040
Klaro UI doesn't include any typefaces. The Klaro text will include the font defined for the document.
4141

42-
The Klaro UI default stylesheet renders a light colored theme when a user's system appearance is set to light colors and a dark colored theme when set to dark colors.
42+
The default stylesheet **klaro-ui.css** renders a light colored theme when a user's system appearance is set to light colors and a dark colored theme when set to dark colors. This default appearance is recommended, as it's more accessible for users than the static light and dark themes listed below.
4343

4444
For only the light colored theme, use **klaro-ui-light.css** within **klaro-ui/dist**.
4545

0 commit comments

Comments
 (0)