softaworks/agent-toolkit / skills/crafting-effective-readmes
crafting-effective-readmes
VerifiedUse when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
Security report
VerifiedStatic analysis of one exact version. It reduces risk and shows evidence; it does not certify that a skill is safe.
- Commit
3027f20f3181758385a1bb8c022d4041dfb4de84- Content hash
e4c5a3ec30f44906b1333d2f6d27011b50631bf024295cb068f422382fdb5b5a- Scanned
- 2026-11-17
- Scanner version
- skillxone-scan-1.0.0
- Policy version
- 0.1-draft
- Decision
- Every required check completed with no open blocking or medium findings.
- Verification expires
- 2026-12-17
Findings (13 low)
A link uses unencrypted http:// (pdp-10.trailing-edge.com), so its content can be altered in transit.
PDP-10](http://pdp-10.trailing-edge.com/decuslib10-04/01/43,50322/read.me.html),Suggested fix: Use https://.
A link uses unencrypted http:// (node-modules.com), so its content can be altered in transit.
[node-modules.com](http://node-modules.com/), a npm search replacement thatSuggested fix: Use https://.
A link uses unencrypted http:// (perlmonks.org), so its content can be altered in transit.
It so turns out that the [monks](http://perlmonks.org) of the Perl communitySuggested fix: Use https://.
A link uses unencrypted http:// (search.cpan.org), so its content can be altered in transit.
READMEs](http://search.cpan.org/~kane/Archive-Tar/lib/Archive/Tar.pm). CPAN is aSuggested fix: Use https://.
A link uses unencrypted http:// (mathforum.org), so its content can be altered in transit.
-- [Ken Williams](http://mathforum.org/ken/perl_modules.html#document)Suggested fix: Use https://.
A link uses unencrypted http:// (kira.solar), so its content can be altered in transit.
Hi, I'm [Kira](http://kira.solar).Suggested fix: Use https://.
A link uses unencrypted http:// (tom.preston-werner.com), so its content can be altered in transit.
- [README-Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)Suggested fix: Use https://.
A link uses unencrypted http:// (joeyh.name), so its content can be altered in transit.
- [Documentation First](http://joeyh.name/blog/entry/documentation_first/)Suggested fix: Use https://.
A link uses unencrypted http:// (catb.org), so its content can be altered in transit.
2. <a name="footnote-2"></a>See [The Jargon File](http://catb.org/~esr/jargon/html/R/README-file.html).Suggested fix: Use https://.
A link uses unencrypted http:// (shields.io), so its content can be altered in transit.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use [Shields.io](http://shields.io/) to add some to your README. Many services also have instructions…Suggested fix: Use https://.
A link uses unencrypted http:// (keepachangelog.com), so its content can be altered in transit.
A [changelog](https://en.wikipedia.org/wiki/Changelog) is another file that is very useful for programming projects. See [Keep a Changelog](http://keepachangelog.com/).Suggested fix: Use https://.
A link uses unencrypted http:// (shields.io), so its content can be altered in transit.
- Use http://shields.io or a similar service to create and host the images.Suggested fix: Use https://.
A link uses unencrypted http:// (perldoc.perl.org), so its content can be altered in transit.
~ [Kirrily "Skud" Robert, perlmodstyle](http://perldoc.perl.org/perlmodstyle.html)Suggested fix: Use https://.
Checks run
- prompt-injection
- dangerous-commands
- credentials
- network
- file-access
- integrity
Checks skipped
- dependencies: No dependency manifest in the skill directory.
- gitleaks: gitleaks is not installed on this host.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 467k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 196k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |