docs: tighten the README, add contributing and the Raycast extension - #7
Merged
Conversation
Cuts about 300 words of narration, mostly the stats section explaining an analytical mistake that belongs in the skill rather than on the front page. Adds a Raycast section with a screenshot, says where the Homebrew tap lives, and adds CI, release and licence badges — the CI one because this repo sat red for a day without anyone noticing.
Restructured rather than trimmed. How it works moves up, status and stats lose their sections and keep one bullet each, and the getting started block now shows what actually changes in a workflow file, which was the missing step between installing and using it. Drops the ephemeral-VM bullet: the two-per-machine cap is on VMs, not runners, so it was competitive positioning rather than something you need to operate this. Contributing and licence sections go too, since the files exist and GitHub surfaces both. 985 words from 1595, with a workflow example and a Raycast section added along the way.
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.
Opened for review rather than to merge blind. Read the rendered README on the branch, not the diff.
README
About 300 words lighter, while adding three things it did not have.
Most of the cut is the
statssection, which had grown into five paragraphs narrating an analytical mistake. That reasoning is worth keeping, but inskills/runpool/where an agent will actually use it, not on the front page where someone is trying to find out what the command does. Similar trims tostatus, notifications, and the concurrency bullet.Added:
brew upgradeworks.Kept as they were: the commands table, the no-user-account-scope point, the GitHub-column explanation, and the public-repository refusal.
CONTRIBUTING.md
Short. What is out of scope and why, the bash 3.2 and no-dependencies constraints, the two commands CI runs, and how to run shellcheck through Docker when it is not installed.
Also here
assets/raycast.png, downscaled to 1200px from the store screenshot.