Skip to content

Commit ea85af1

Browse files
committed
Add link to article, rework description
1 parent f52c48d commit ea85af1

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
# `<dark-mode-toggle>` Element
44

55
A custom element that allows you to easily put a *Dark Mode 🌒* toggle
6-
or switch on your site and that adds
7-
[`prefers-color-scheme`](https://drafts.csswg.org/mediaqueries-5/#prefers-color-scheme)
8-
support even to browsers that don't support the media feature natively.
6+
or switch on your site, so you can initially adhere to your users' preferences according to
7+
[`prefers-color-scheme`](https://drafts.csswg.org/mediaqueries-5/#prefers-color-scheme),
8+
but also allow them to (optionally permanently) override their system setting for just your site.
9+
10+
📚 Read all(!) about dark mode in the related article
11+
[Hello Darkness, My Old Friend](https://web.dev/prefers-color-scheme/).
912

1013
## Installation
1114

@@ -20,14 +23,12 @@ In the browser:
2023
```js
2124
import * as DarkModeToggle from 'https://cdn.pika.dev/dark-mode-toggle';
2225
```
23-
or
26+
or
2427

2528
```js
2629
import * as DarkModeToggle from 'https://unpkg.com/dark-mode-toggle';
2730
```
2831

29-
30-
3132
## Usage
3233

3334
⚠️ The custom element assumes that you have organized your CSS in different files

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dark-mode-toggle",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "Web Component that toggles dark mode 🌒",
55
"main": "./src/dark-mode-toggle.mjs",
66
"browser": "src/dark-mode-toggle.mjs",

0 commit comments

Comments
 (0)