Skip to content

Commit

Permalink
Update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
EdMSL committed Jul 23, 2024
1 parent 4f644f4 commit e3cc18e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@ Update packages to fix secure vulnerabilities.

## 1.1.0 (April 2, 2022)
Migrate to PostCSS 8.0 API.

## 1.1.1 (July 23, 2024)
Fix incorrect conversion for `rgb()` and `hsl()` color functions with modern notation ([issue](https://github.com/EdMSL/postcss-color-converter/issues/18)).<br>
Update packages to fix secure vulnerabilities.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# postcss-color-converter

> [PostCSS](https://github.com/postcss/postcss) plugin to convert HEX, RGB, HSL and keyword colors between themselves (without transform to keyword color format). Uses [color-convert](https://www.npmjs.com/package/color-convert) under hood. Support Sass(SCSS) ([postcss-scss](https://www.npmjs.com/package/postcss-scss) or [postcss-sass](https://www.npmjs.com/package/postcss-sass) need) and CSS variables.
> [PostCSS](https://github.com/postcss/postcss) plugin to convert HEX, RGB, HSL and keyword colors between themselves (without transform to keyword color format). Uses [color-convert](https://www.npmjs.com/package/color-convert) under hood. Supports modern color function notation ([specification](https://drafts.csswg.org/css-color/#the-hsl-notation)), Sass(SCSS) ([postcss-scss](https://www.npmjs.com/package/postcss-scss) or [postcss-sass](https://www.npmjs.com/package/postcss-sass) needed) and CSS variables.
## Installation
```console
Expand Down Expand Up @@ -53,7 +53,7 @@ Then:
npm run postcss
```

Please refer to [PostCSS documentation](https://github.com/postcss/postcss#usage) for you current environment.
Please refer to [PostCSS documentation](https://github.com/postcss/postcss#usage) for your current environment.

## Options

Expand All @@ -68,7 +68,7 @@ Set output color format. Don't forget set this parameter.
Type: `String[]`<br>
Available values: `hex, rgb, hsl, keyword`<br>
Default: `[]`<br>
Array of color formats, which you do not want to convert.
Array of color formats, which you don't want to convert.

#### `alwaysAlpha`
Type: `Boolean`<br>
Expand All @@ -86,7 +86,7 @@ colorConverter({

## Examples

Using this `input.css` and `input.scss` with option `outputColorFormat`: 'rgb':
Using these `input.css` and `input.scss` with `outputColorFormat`: 'rgb' option:

```css
body {
Expand All @@ -107,7 +107,7 @@ p {
}
```

you will get:
you'll get:

```css
body {
Expand Down Expand Up @@ -136,7 +136,7 @@ $ npm i
$ npm run postcss
```

Then go to `test/fixtures` folder and see `common.test.scss` file.
Then go to the `test/fixtures` folder and see the `common.test.scss` file.

## Contributing

Expand Down

0 comments on commit e3cc18e

Please sign in to comment.