diff options
author | Benjamin Chausse <benjamin@chausse.xyz> | 2024-11-25 15:17:02 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-11-25 15:17:02 -0500 |
commit | fe46976256aa3a5cac9baf745ac1debcb49d00c0 (patch) | |
tree | fa093a584b6990827fbb1bed37feccc3958ab71f | |
parent | 6981c08b60cccc7454038bb21391bd585a133684 (diff) |
fix: enhance readme, and update notice duration (#12)
* Move main.go to root for easy go install ...
* Better README
* elongate notice duration
-rw-r--r-- | .goreleaser.yaml | 2 | ||||
-rw-r--r-- | README.md | 29 | ||||
-rw-r--r-- | flags.go (renamed from cmd/termpicker/flags.go) | 0 | ||||
-rw-r--r-- | internal/notices/notices.go | 2 | ||||
-rw-r--r-- | main.go (renamed from cmd/termpicker/main.go) | 0 |
5 files changed, 26 insertions, 7 deletions
diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 2518c49..ddecc2d 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -10,7 +10,7 @@ version: 2 before: hooks: [go mod tidy] builds: - - main: ./cmd/termpicker/ + - main: env: [CGO_ENABLED=0] goos: [linux, windows, darwin] archives: @@ -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: <div align="center"> <img src="./assets/demo.gif" width="600" alt="Termpicker Demo"><br> </div> -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 diff --git a/cmd/termpicker/flags.go b/flags.go index 660c053..660c053 100644 --- a/cmd/termpicker/flags.go +++ b/flags.go diff --git a/internal/notices/notices.go b/internal/notices/notices.go index 49fb179..4fbd807 100644 --- a/internal/notices/notices.go +++ b/internal/notices/notices.go @@ -11,7 +11,7 @@ import ( ) const ( - expiryDelay = 1 // seconds + expiryDelay = 3 // seconds ) type NoticeExpiryMsg string diff --git a/cmd/termpicker/main.go b/main.go index 241adcf..241adcf 100644 --- a/cmd/termpicker/main.go +++ b/main.go |