Skip to content

docs: rewrite README, categorize 67 more formulas - #6

Merged
batuhan-bas merged 2 commits into
mainfrom
docs/readme
Oct 8, 2026
Merged

batuhan-bas merged 2 commits into
mainfrom
docs/readme

Conversation

@batuhan-bas

Copy link
Copy Markdown
Owner

Stacked on #5. Merge last.

Categories (feat commit)

  • Every formula that ended up under Other on a real machine (29). Examples: postgresql@17, gitleaks, cmake, openjdk@17, ruby, the GnuPG stack, poppler.
  • Plus common formulas: jq, fzf, bat, eza, fd, neovim, tmux, docker, colima, kubernetes-cli, helm, awscli, mysql, redis, uv, rust, deno, …
  • All 38 popular names were checked against Homebrew. terraform was left out: it is no longer in homebrew/core.
  • Result on that machine: 0 formulas under Other (was 29). 226 categorized formulas in total.

README

  • Preview generated by the script from sample packages, not the author's own list.
  • Install: brew install batuhan-bas/tap/brewshelf, or install -m 755 … "$(brew --prefix)/bin/brewshelf". No sudo, and it works on Apple Silicon. The old sudo cp … /usr/local/bin didn't, because that directory doesn't exist there.
  • YOUR_USERNAME placeholder removed.
  • New sections: options, dependency hiding, where descriptions come from, requirements (no extra dependencies), contributing + tests.

⚠️ Before merging

The Homebrew install line needs the tap (batuhan-bas/homebrew-tap) and a v1.0.0 release to exist. The release follows once this stack is on main.

Every formula that ended up under "Other" on a real machine (29, e.g.
postgresql@17, gitleaks, cmake, openjdk@17, the GnuPG stack) plus common
formulas such as jq, fzf, bat, neovim, docker, kubernetes-cli, mysql and
redis. All names verified against Homebrew.
- real preview generated from the script (sample packages)
- install with Homebrew or with `install` into $(brew --prefix)/bin —
  no sudo, works on Apple Silicon (the old /usr/local/bin + sudo
  instructions did not)
- remove the YOUR_USERNAME placeholder
- document options, dependency hiding, descriptions, requirements
- contributing: how to add a category and run the tests
Base automatically changed from feat/cli-options to main October 8, 2026 08:18
@batuhan-bas
batuhan-bas merged commit b157c89 into main Oct 8, 2026
1 check passed
@batuhan-bas batuhan-bas self-assigned this Oct 8, 2026
@batuhan-bas
batuhan-bas deleted the docs/readme branch October 8, 2026 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant