diff --git a/README.md b/README.md index 95ece54..f070720 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,30 @@ -# Colors +Colors -This is a collection of functions for performing color operations, designed to work with the LÖVE game engine. + This is a collection of functions for performing color operations, designed to work with the LÖVE game engine. -## Documentation + ## Documentation -Supports following color formats: - -rgb255: The standard computer representation, with each + Supports following color formats: +- `rgb255`: The standard computer representation, with each +``` channel (red, green, blue, alpha) in the [0-255] range. Alpha channel (index 4), can either be explicit or implicit (and taken to be 255.) +``` +- `rgb1`: As above, except channels are in the [0-1] range. +- `hsl`: Hue-saturation-lightness representation (does not support alpha). -rgb1: As above, except channels are in the [0-1] range. -hsl: Hue-saturation-lightness representation (does not support alpha). - - +``` Hue channel is in the [0-1] range, instead of the standard [0-2*pi] range. +``` -## Functions +## [Functions](#Functions) interpolate_rgb (c1, c2, t) Interpolation @@ -37,7 +38,7 @@ Inversion parse_rgb (str) Parsing -## Functions +## [None](None)Functions interpolate_rgb (c1, c2, t) @@ -82,8 +83,6 @@ parse_rgb (str) str Error handling - - # License ```