docs: rework the README header, features, and pitch - #160
Merged
Merged
Conversation
Contributor
🤖 MERGED
GitHub merged this pull request. No material findings were recorded. 785afc6a-4ee8-4edb-94a1-53c0140da815 |
Collaborator
Author
1 task
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
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.




❓ Type of change
📚 Description
The feature list was selling the registry, not the CLI. "Every Skill has a human author" describes what skilld.dev is; someone deciding whether to run
npx skilldcannot act on it. That claim already lives in the tagline and in "What is skilld?", so it stays there and leaves the list. The five now cover what you get from the binary: transient runs, multi-target install, startup, pinning, and privacy.Two numbers are sourced rather than adjectives.
AGENT_TARGETSincrates/skilld-core/src/target.rsholds 19 entries, so the install bullet says 19. Startup ishyperfine -N ./target/release/skilld --version: 454 µs ± 73 µs here, against 12.8 ms for a barenode -e "". The bullet says "under a millisecond" rather than the raw figure, since a README number gets quoted back on hardware I have not tested.The header had the title, the badges, the tagline and the logo in four separate blocks, with the logo stranded below the tagline. It is one centred lockup now.
logo.svgalready had the mark and the word side by side, but drew the word as SVG<text>in IBM Plex Mono, which GitHub and npm cannot load, so it would have fallen back to whatever monospace the reader has. Both wordmarks are outlined to paths now, so they render identically with no font dependency, and the viewBox is cropped to the artwork instead of carrying 130px of dead space. Nothing else in the repo referenced those two files. Screenshots of both themes are in a comment below.Badges were
color=yellowagainst a rose and stone brand, so they now use#e11d48on#1c1917, taken fromlogo-light.svg. Image URLs are absolute, because relative paths do not resolve on npmjs.com; the old logo was already broken there.The repo description moved to "open-source, privacy friendly" and the README and
package.jsonwere still running two older pitches between them. All three say the same thing now. The skills.sh comparison stays on the GitHub description, where someone is searching; on our own README it would send the reader off to look up a competitor.Open question:
bin/skilld.mjsspawns through Node on the npm path, so "no runtime to install" only holds for thecurlinstall. The bullet sayscurlfor that reason, but the npm loader may be worth naming out loud somewhere.Still missing: there is no
COPY.md, which is why three descriptions drifted apart without anyone noticing. Worth bootstrapping separately.