docs

.gitignore

@@ -1,4 +1,5 @@
 .idea
+.vscode
 build
 composer.lock
 docs

README.md

@@ -9,6 +9,8 @@ Provides various utilities for working with color contrast.
 
 The primary purpose is to facilitate easy generation of accessible (minimum 3.0 contrast ratio) hex color pairs. A variation of these tools restricts the generated colors to [TailwindCSS's](https://tailwindcss.com/) default palette.
 
+I've created a [demo page](https://mumu.pw/contrast) to show how color pairs can be generated by this package. 
+
 ## Installation
 
 You can install the package via composer:
@@ -22,15 +24,17 @@ composer require breadthe/php-contrast
 Import the class.
 
 ```php
-use Breadthe\PhpContrast\HexColor;
-use Breadthe\PhpContrast\HexColorPair;
-use Breadthe\PhpContrast\TailwindColor;
+use Breadthe\PhpContrast\HexColor; // factory
+
+use Breadthe\PhpContrast\HexColorPair; // hex pair utilities
+
+use Breadthe\PhpContrast\TailwindColor; // Tailwind color pair utilities
 ```
 
 ## Check the contrast ratio between 2 colors
 
 ```php
-$hexColorPair = HexColor::make(HexColor::make('000000'), HexColor::make('ffffff'));
+$hexColorPair = HexColorPair::make(HexColor::make('000000'), HexColor::make('ffffff'));
 $hexColorPair->ratio; // 21
 $hexColorPair->fg; // '#000000'
 $hexColorPair->bg; // '#ffffff'
@@ -66,10 +70,10 @@ $hexColorPair->bg->name; // null
 
 ```php
 // Minimum 3:1 contrast ratio
-HexColorPair::sibling('0000000'); // [21, '0000000', 'ffffff']
+HexColorPair::sibling('000000'); // [21, '000000', 'ffffff']
 
 // Minimum specified contrast ratio (no less than 3:1)
-HexColorPair::minContrast(4.5)->getSibling('0000000'); // [21, '0000000', 'ffffff']
+HexColorPair::minContrast(4.5)->getSibling('000000'); // [21, '000000', 'ffffff']
 ```
 
 ## Generate a random TailwindCSS color