Skip to content

Refactor FAQ section in README.md #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
K1-R1 merged 1 commit into from
Mar 26, 2026
Merged

Refactor FAQ section in README.md #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Turn git repos into AI context. Pure bash, zero dependencies. RAG-ready.
brew install K1-R1/tap/smoosh

# In any git repo:
smoosh # docs only (default)
smoosh --code # docs + code files
smoosh --all # everything tracked by git
smoosh # interactive guided setup
smoosh --code # docs + code
smoosh --all # everything tracked by git (excluding binaries)
```

Output lands in `_smooshes/` as verified `.md` chunks.
Expand Down Expand Up @@ -273,14 +273,14 @@ Exit codes 0–7 are differentiated for programmatic decision-making — see

## FAQ

**Does it respect `.gitignore`?** Yes, via `git ls-files`.
**What about large repos?** Chunks at `--max-words` (default 450k).
**Is secret detection reliable?** It catches common patterns, but isn't a replacement for `gitleaks`.
**Can I use it with other AIs?** Yes, it fundamentally outputs standard Markdown (or text/XML mapping).
**Does it work on Windows?** Use Git Bash or WSL.
**Why did `_smooshes/` appear in git status?** We auto-append it to `.gitignore`, ensure your syntax is correct.
**Why is my word count different?** Files are counted via `wc -w`, so dense syntax (minified JS, JSON) counts differently than prose.
**Is this overengineered?** Yes. 231 tests, strict verification, XML escaping, and a bespoke ANSI logo for a bash script. Your codebase deserves it.
- **Does it respect `.gitignore`?** Yes, via `git ls-files`.
- **What about large repos?** Chunks at `--max-words` (default 450k).
- **Is secret detection reliable?** It catches common patterns, but isn't a replacement for `gitleaks`.
- **Can I use it with other AIs?** Yes, it fundamentally outputs standard Markdown (or text/XML mapping).
- **Does it work on Windows?** Use Git Bash or WSL.
- **Why did `_smooshes/` appear in git status?** We auto-append it to `.gitignore`, ensure your syntax is correct.
- **Why is my word count different?** Files are counted via `wc -w`, so dense syntax (minified JS, JSON) counts differently than prose.
- **Is this overengineered?** No comment.

## Contributing

Expand Down