aboutsummaryrefslogtreecommitdiff
path: root/aoc2023/build/packages/gleam_community_colour/README.md
diff options
context:
space:
mode:
authorJ.J <thechairman@thechairman.info>2024-05-30 21:50:02 -0400
committerJ.J <thechairman@thechairman.info>2024-05-30 21:50:02 -0400
commit612fd986ab1e00b6d34dc1937136250e08e89325 (patch)
treea3c93952040c6afdf348b5831619a45db7ba0a2e /aoc2023/build/packages/gleam_community_colour/README.md
parent231c2b688d1e6cf0846d46e883da30e042a9c6cf (diff)
downloadgleam_aoc-612fd986ab1e00b6d34dc1937136250e08e89325.tar.gz
gleam_aoc-612fd986ab1e00b6d34dc1937136250e08e89325.zip
cleanup
Diffstat (limited to 'aoc2023/build/packages/gleam_community_colour/README.md')
-rw-r--r--aoc2023/build/packages/gleam_community_colour/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/aoc2023/build/packages/gleam_community_colour/README.md b/aoc2023/build/packages/gleam_community_colour/README.md
new file mode 100644
index 0000000..0eccdd7
--- /dev/null
+++ b/aoc2023/build/packages/gleam_community_colour/README.md
@@ -0,0 +1,36 @@
+# gleam-community/colour
+
+A package for a standard Colour type, conversions, and other utilities.
+
+[![Package Version](https://img.shields.io/hexpm/v/gleam_community_colour)](https://hex.pm/packages/gleam_community_colour)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gleam_community_colour/)
+
+✨ This project is written in pure Gleam so you can use it anywhere Gleam runs: Erlang, Elixir, Node, Deno, and the browser!
+
+---
+
+## Quickstart
+
+```gleam
+import gleam_community/colour
+import gleam_community/colour/accessibility
+
+pub fn main() {
+ let foreground = colour.from_hsl(h: 0.858, s: 1.0, l: 0.843)
+
+ let background_options = [colour.light_grey, colour.dark_grey]
+
+ let background = accessibility.maximum_contrast(foreground, background_options)
+}
+```
+
+## Installation
+
+`gleam_community` packages are published to [hex.pm](https://hex.pm/packages/gleam_community_colour)
+with the prefix `gleam_community_`. You can add them to your Gleam projects directly:
+
+```sh
+gleam add gleam_community_colour
+```
+
+The docs can be found over at [hexdocs.pm](https://hexdocs.pm/gleam_community_colour).