From b41a2c5c0b5bfaa4b993df20541929f4140906c8 Mon Sep 17 00:00:00 2001 From: JoelCDL Date: Wed, 29 Jan 2025 12:28:02 -0800 Subject: [PATCH] Clarify installation requirements and appearance options --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bb61e76..557139c 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ View sample at https://cdlib.github.io/klaro-ui ## Requirements -- Git - Node version 20 or above - NPM version 10 or above -- Klaro source and a valid config file +- Klaro source script and config file +- Modifying the loading of third-party scripts in your application's HTML ## Installation -1. Follow the steps in [Getting Started](https://klaro.org/docs/getting-started) within the Klaro documentation. +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. 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: @@ -39,7 +39,7 @@ The module **klaro-ui** is now installed in your application's **node_modules** Klaro UI doesn't include any typefaces. The Klaro text will include the font defined for the document. -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. +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. For only the light colored theme, use **klaro-ui-light.css** within **klaro-ui/dist**.