Add a simple README
- ID
c7615d9- date
2022-07-10 08:50:59+00:00- author
Alex Chan <alex@alexwlchan.net>- parent
3226020- message
Add a simple README- changed files
4 files, 27 additions, 1 deletion
Changed files
LICENSE (0) → LICENSE (1053)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..44556ad
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2022 Alex Chan
+
+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 (298) → README.md (745)
diff --git a/README.md b/README.md
index 185bcdb..71df67c 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,11 @@
This is a command-line tool to show a selection of darker/lighter variants of a different colour.
-<img src="./screenshot.png" alt="A terminal window running the command 'brightness_adjust #d01c11', followed by different shades of the same colour, ranging from dark to light.">
\ No newline at end of file
+<img src="./screenshot_yellow.png" alt="A terminal window running the command 'brightness_adjust #e9a924', followed by different shades of the same colour, ranging from dark to light.">
+
+I use it when there's a specific hue/saturation I want to use (e.g. chosen by [dominant_colours]), but it's too dark or light to use in a particular context.
+
+For example, in the screenshot above, I have a bright shade of yellow `#e9a924`.
+This is far too bright to be readable against a white background -- but I have a range of similar colours I can use in its place.
+
+[dominant_colours]: https://github.com/alexwlchan/dominant_colours
screenshot.png (515784) → screenshot.png (0)
diff --git a/screenshot.png b/screenshot.png
deleted file mode 100644
index c6ab22f..0000000
Binary files a/screenshot.png and /dev/null differ
screenshot_yellow.png (0) → screenshot_yellow.png (443065)
diff --git a/screenshot_yellow.png b/screenshot_yellow.png
new file mode 100644
index 0000000..356a8a3
Binary files /dev/null and b/screenshot_yellow.png differ