README.md

huetiful-js

TypeScript library for general purpose color manipulations and generating custom color scales.

📜 Docs · 🐞 Report Bug · 🍩 Request Feature · 🧠 Wiki

Table of Contents

• Installation and usage
  • Node
  • Browser
  • Quickstart
  • Documentation 📜
• Community
  • 😣 Need help ?
  • 🎁 Contributing
• 👏 Sponsoring issues
• References🔗
  • License

Installation and usage

Node

The library🧾 is on npm as a package📦 for use in NodeJS:

npm i huetiful-js

You can use a CDN in this example, jsdelivr to load the library remotely:

import {...} from 'https://cdn.jsdelivr.net/npm/huetiful-js/lib/huetiful.esm.mjs'

Browser

Or load the library as a UMD glabal (huetiful) in your HTML file using a <script> tag:

# With script tag

<script src='https://cdn.jsdelivr.net/npm/huetiful-js/dist/huetiful.umd.js'></script>

Quickstart

See the Quickstart section on the Wiki to see some examples and demonstrations of the library.

Documentation 📜

Want to explore the full API? See the full docs here

Community

Would like to join the chat🗣️ and share ideas💡 and suggestions💭 ? See the discussions and just say hi, or share a coding meme(whatever breaks the ice🏔️)

😣 Need help ?

See some unexpected results😖? Check the issue tracker to open an issue or search for the problem to see if your issue already exists or has been resolved.

🎁 Contributing

This project is fully open source! Contributions of any kind are greatly appreciated! See🔍 the CONTRIBUTING file for more information on how to get started.

👏 Sponsoring issues

Sponsored issues have higher priority over non-critical issues.

You can either request a new feature or a bug fix then fund it.

The money will be transparently split with an issue's assignees.

References🔗

Coloring with code: A programmatic approach by George Francis

License

Copyright (c) 2023, Dean Tarisai and contributors huetiful-js is released under the Apache 2.0 license.