Skip to content

Commit b7f1f88

Browse files
committed
Add more details to the readme file
1 parent 10327ea commit b7f1f88

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*.sublime-workspace
22
.DS_Store
33
build/
4+
bundled/
45
node_modules
56
*.log
67
.nyc_output/

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,28 @@
22

33
<a href="https://www.npmjs.org/package/culori"><img src="https://img.shields.io/npm/v/culori.svg?style=flat-square&labelColor=d84f4c&color=black" alt="npm version"></a> <a href="https://bundlephobia.com/result?p=culori"><img src="https://img.shields.io/bundlephobia/minzip/culori?style=flat-square&labelColor=d84f4c&color=black" alt="bundle size"></a>
44

5-
Culori is a color library for JavaScript that works across many color spaces to offer conversion, interpolation, color difference formulas, blending functions, and more.
5+
Culori is a comprehensive color library for JavaScript that works across many color spaces to offer conversion, interpolation, color difference formulas, blending functions, and more. It provides up-to-date support for the color spaces defined in [CSS Color Module Level 4](https://drafts.csswg.org/css-color/) specification.
6+
7+
The full documentation is published on [culorijs.org](https://culorijs.org). Some quick entry points:
8+
9+
- [Getting started](https://culorijs.org/getting-started)
10+
- [API References](https://culorijs.org/api/)
11+
- [Supported color spaces](https://culorijs.org/color-spaces/)
12+
13+
## Development
14+
15+
The 0.x branch:
616

717
```bash
818
npm install culori
919
```
1020

11-
[Read the documentation](https://culorijs.org)
21+
[The 1.x branch](https://github.com/Evercoder/culori/pull/139), currently in development, uses the `next` tag:
22+
23+
```bash
24+
npm install culori@next
25+
```
26+
27+
## Contributing
28+
29+
Contributions of any kind (feedback, ideas, bug fixes) are welcome. Please open a GitHub issue before starting work on anything that's not straightforward.

0 commit comments

Comments
 (0)