docs: add README - #42
Merged
Merged
Conversation
Adds install (Releases and go install), shell setup for fish/bash/zsh, first-run scan, usage and keymaps, full config.toml reference with XDG paths, a glossary-grounded "how it works", and a demo placeholder for the maintainer to record. Closes #23 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds the repo's README.md: a one-line pitch, a Demo section (placeholder
with an HTML comment noting the maintainer records it — no recording tool
was available in this environment), install instructions (GitHub Releases
tar.gz per linux/darwin amd64/arm64 with checksums.txt verification, and
go install), shell setup for fish/bash/zsh, first-runcdd scan, usageand both key maps (default and vim), a full
config.tomlreference withevery key explained, the XDG paths for config and History, a three-sentence
"How it works" using the glossary terms (Scan, Visit, History, Picker,
Project, Jump, Wrapper), and pointers to CONTRIBUTING.md and the license.
Why
Turns the last red item in the repo's Community Standards green and gives
new users install/setup instructions.
Commands and flags were derived from
go run ./cmd/cdd --helpandgo run ./cmd/cdd init --help, plus the actual key bindings ininternal/picker/update.goand config fields ininternal/config/config.go.Closes #23
🤖 Generated with Claude Code