From fe46976256aa3a5cac9baf745ac1debcb49d00c0 Mon Sep 17 00:00:00 2001 From: Benjamin Chausse Date: Mon, 25 Nov 2024 15:17:02 -0500 Subject: fix: enhance readme, and update notice duration (#12) * Move main.go to root for easy go install ... * Better README * elongate notice duration --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ab11cbe..fbdc3c4 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,37 @@ A simple Color Picker Designed for your Terminal -This is very much a work in progress, but the end goal is to be able to -generate and copy colors from the terminal. - Here is a quick demo of what has been done so far:
Termpicker Demo
-Here is my roadmap to reach what I would consider a finished state: +## Features: + +- Preview any color using a truecolor terminal +- Create colors using sliders for RGB, HSL, and CMYK +- Seamlessly convert between color formats (RGB, HSL, CMYK) as you create +- Copy the color to your clipboard in various formats (RGB, HEX, HSL, CMYK) + +## Usage: + +The keybindings are pretty simple and shown in the UI. For a more exhaustive +list, pressing `?` expands the help section to show all available keybindings. + +## Installation + +Just grab the latest release for your platform and install the binary +somewhere in your `PATH`. + +Alternatively, you can install it directly from go with: +```sh +go install github.com/ChausseBenjamin/termpicker@latest +``` + +## Roadmap +- [ ] Add an input flag to pass specific color as a starting value - [ ] Add a "cmd" mode to manually input colors -- [ ] Allow to pass a starting color as an argument when launching the program - [ ] Make the tabs interface prettier with [lipgloss][1] (similar to tabs in [soft-serve][2]) - [ ] Notify user of successful copy to clipboard (or failure) - [ ] Unit-test color conversions near edge case colors -- cgit v1.2.3