Permalink
Browse files

documented methods

  • Loading branch information...
1 parent c04f208 commit 5a0f9079a984da2738c2efa2ffa29a5da90fea7b @substack substack committed Jul 10, 2011
Showing with 33 additions and 1 deletion.
  1. +33 −1 README.markdown
View
@@ -4,4 +4,36 @@ Mr. Color
I just want some colors, you know?
This module gives you some colors which are all different but they get less
-different the more you want.
+different the more colors you load.
+
+The hue is deterministic but the saturation and luminosity vary increasingly
+randomly the more colors are generated.
+
+methods
+=======
+
+var mr = require('mrcolor');
+
+var next = mr();
+----------------
+
+Call `next()` repeatedly to get more colors.
+
+mr.take(n)
+----------
+
+Generate `n` colors as an array.
+
+color objects
+=============
+
+Color objects have these methods:
+
+* rgb()
+* hsl()
+* hsv()
+* cmyk()
+* xyz()
+
+The return values are arrays with each of the color parameters.
+See [color-convert](https://github.com/harthur/color-convert) for more info.

0 comments on commit 5a0f907

Please sign in to comment.