Document all function and add code samples

[FluorescentHallucinogen]

The packages from this project definitely need docs. :)

[guidezpl]

Can you please elaborate? There's only a Dart package at the moment.

[FluorescentHallucinogen]

Yes, currently there's only a Dart package,but it seems TypeScript npm package is on horizon. :)

I mean docs for every function and how to use them. Maybe auto-generated from source code annotations. But samples could be very useful too.

[guidezpl]

I agree, complete documentation is on the roadmap! Stay tuned

[FluorescentHallucinogen]

One of the samples I'm very interested in is how to pass image to material-color-utilities. Obviously, some sort of image selector is needed. But what next? What data format does it expect? Should I use Web Workers, OffscreenCanvas, WebAssembly, etc.

[FluorescentHallucinogen]

Just found cool demo for inspiration: https://lokeshdhakar.com/projects/color-thief/. :wink:

[guidezpl]

I'm currently working on a new module to add to the libraries, called extract. It'll be make the process really easy, give it some image and it returns top colors. Coming soon!

[selfire1]

Hi! I would love to use this project in TypeScript to generate a colour palette from a single source colour. Being in a bit over my head with how to use these utilities, having additional documentation would be great!

[rodydavis]

Typescript example added :)

[Galileo01]

The document is necessary