# color2k: Project

## Credits

color2k owes a lot to [polished](https://github.com/styled-components/polished) and [Sass](https://sass-lang.com). Much of the implementation is copied from polished.

Thanks to everyone who has pitched in:

- [@delucis](https://github.com/delucis) (Chris Swithinbank) made `mix` return valid colors when one side is transparent at the ends of the weight range ([#409](https://github.com/ricokahler/color2k/pull/409)).
- [@Myndex](https://github.com/Myndex) corrected the luminance threshold that `readableColor` uses to pick black or white ([#472](https://github.com/ricokahler/color2k/pull/472)).
- [@feritcemkahraman](https://github.com/feritcemkahraman) brought the full Sass alpha weighting to `mix` ([#564](https://github.com/ricokahler/color2k/pull/564), shipped in [#572](https://github.com/ricokahler/color2k/pull/572)).
- [@dajiaohuang](https://github.com/dajiaohuang) and [@Ismayil77](https://github.com/Ismayil77) made the parser ignore whitespace around color strings ([#561](https://github.com/ricokahler/color2k/pull/561), [#567](https://github.com/ricokahler/color2k/pull/567), shipped in [#571](https://github.com/ricokahler/color2k/pull/571)).
- [@ljharb](https://github.com/ljharb) (Jordan Harband) restored Node 6 compatibility ([#355](https://github.com/ricokahler/color2k/pull/355)).
- [@diondiondion](https://github.com/diondiondion) improved the documentation ([#245](https://github.com/ricokahler/color2k/pull/245)).
- [@bombillazo](https://github.com/bombillazo) asked for `invert` ([#449](https://github.com/ricokahler/color2k/issues/449)) and co-wrote it ([#575](https://github.com/ricokahler/color2k/pull/575)).
- [@okikio](https://github.com/okikio) (Okiki Ojo) updated the bundlejs.com links ([#429](https://github.com/ricokahler/color2k/pull/429)).

See everyone on the [contributors graph](https://github.com/ricokahler/color2k/graphs/contributors).

## Contributing

Issues and pull requests are welcome. Clone the repo and run `npm ci`, then `npm run check` runs everything CI does. Each function is one small file in `src` with its test next to it, so most fixes touch two files.

[CONTRIBUTING.md](https://github.com/ricokahler/color2k/blob/main/CONTRIBUTING.md) gets you set up, and [AGENTS.md](https://github.com/ricokahler/color2k/blob/main/AGENTS.md) has the same rules for coding agents.

## Trust and publishing

- No runtime dependencies.
- The published package holds `dist`, `README.md`, `LICENSE` and `package.json`.
- Releases go out from GitHub Actions with npm provenance, through trusted publishing.
- The README, the website and the llms files are built from the JSDoc in `src`. CI fails if they drift.
- Found a security problem? [SECURITY.md](https://github.com/ricokahler/color2k/blob/main/SECURITY.md) says how to report it.
