Skip to content

Commit dcd7eb0

Browse files
committed
clarify readme
1 parent 58fe115 commit dcd7eb0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Color scheme generator
44

5-
[![](https://o.famebot.com/file/famebot/chromagen.png)](https://chromagen.io)
5+
[![example scheme](https://o.famebot.com/file/famebot/chromagen.png)](https://chromagen.io)
66

77
[![npm Version](https://img.shields.io/npm/v/@famebot/chromagen.svg?style=for-the-badge)](https://www.npmjs.com/package/@famebot/chromagen)
88
 
@@ -63,8 +63,10 @@ Using the UMD bundle in the browser:
6363

6464
### Step by step
6565

66-
Chromagen returns an object with values for HSL color schemes randomized within
67-
acceptable parameters:
66+
Chromagen returns an 11 property HSL color scheme object with values randomized
67+
within acceptable parameters. Included are 7 shades of lightness, 1 saturation
68+
level, and 3 hues: the primary hue, its complement, and a hue analogous to the
69+
complement. The generated object for the example scheme in the image above was:
6870

6971
```js
7072
{
@@ -83,8 +85,7 @@ acceptable parameters:
8385
```
8486

8587
Since [v1](https://github.com/famebot/chromagen/releases/tag/v1.0.0), Chromagen
86-
returns mixing values that are not hues with the percent symbol already
87-
included.
88+
returns the percent symbol with all mixing values except hues.
8889

8990
Check [`src/index.js`](./src/index.js) for the nitty gritty. We summarize
9091
breaking changes in the [changelog](./CHANGELOG.md) and the

0 commit comments

Comments
 (0)