Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mirisuzanne committed Apr 20, 2020
1 parent d9ddac7 commit ad8b54a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ for automated adjustments.
npm install @mirisuzanne/blend --save-dev
```

## Warning

- This is still a work-in progress,
and some of the syntax is likely to change.
- More detailed documentation is on the way…

## Usage

```scss
Expand Down Expand Up @@ -63,7 +69,15 @@ $inspect: (
blend.chroma($color),
blend.hue($color), // different from hsl "hue"
);
```

## In Flux

These features are built, but I'm not confident about the syntax.
Feel free to play with it and provide feedback
in [GitHub issues](https://github.com/mirisuzanne/blend/issues)

```scss
// A rough interpretation of the Level 5 relative color syntax
$adjust: (
blend.from($color, l, 20, h), // set chroma to 20
Expand Down

0 comments on commit ad8b54a

Please sign in to comment.