init

Author: mistic100

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Damien "Mistic" Sorel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,58 @@
+# Random Color
+
+For generating attractive random colors. 
+
+This is a PHP port of David Merfield [randomColor](https://github.com/davidmerfield/randomColor) Javascript utility.
+
+See the results on [the demo](http://www.strangeplanet.fr/work/RandomColor.php).
+
+[![Demo](http://llllll.li/randomColor/repo_demo.gif)](http://www.strangeplanet.fr/work/RandomColor.php)
+
+### Options
+
+You can pass an options object to influence the type of color it produces. The options object accepts the following properties:
+
+**Hue** – Controls the hue of the generated color. You can pass a string representing a color name (e.g. 'orange'). Possible color names are *red, orange, yellow, green, blue, purple, pink and monochrome*.
+
+**Luminosity** – Controls the luminosity of the generated color. You can pass a string containing *bright, light or dark*.
+
+**Format** – A string which specifies the format of the generated color. Possible values are *hsv, hsl, hslCss, rgb, rgbCss, and hex*.
+
+### Examples
+
+```php
+
+// Returns a hex code for an attractive color
+RandomColor::one(); 
+
+// Returns an array of ten green colors
+RandomColor::many(10, array(
+   'hue' => 'green'
+));
+
+// Returns a hex code for a light blue
+RandomColor::one(array(
+   'luminosity' => 'light',
+   'hue' => 'blue'
+));
+
+// Returns a hex code for a 'truly random' color
+RandomColor::one(array(
+   'luminosity' => 'random',
+   'hue' => 'random'
+));
+
+// Returns a bright color in RGB
+RandomColor::one(array(
+   'luminosity' => 'bright',
+   'format' => 'rgbCss' // e.g. 'rgb(225,200,20)'
+));
+```
+
+### Other languages
+
+RandomColor is available in [JavaScript](https://github.com/davidmerfield/randomColor), [c#](https://github.com/nathanpjones/randomColorSharped) and [go](https://github.com/hansrodtang/randomcolor).
+
+### License
+
+This project is licensed under the terms of the MIT license.