{"id":"cmuxm4ng2272rad07eo9smkqf","slug":"crafting-effective-readmes","publicId":"435b707c-bb44-4423-9820-3efa7563675a","name":"crafting-effective-readmes","description":"Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.","version":"","author":"softaworks","license":"MIT","compatibility":"","status":"completed","overallGrade":"B","scannerVersion":11,"fileCount":14,"hasSkillMd":true,"hasScripts":false,"hasReferences":true,"hasEvals":false,"hasAssets":false,"sourceType":"github","sourceUrl":"https://github.com/softaworks/agent-toolkit/tree/main/skills/crafting-effective-readmes","createdAt":"2026-10-07T04:33:52.474Z","completedAt":"2026-10-07T04:33:52.472Z","visibility":"public","publishedAt":"2026-07-30T16:08:10.909Z","category":"","frameworks":[],"badgeStatus":"conditional","downloadCount":0,"verdictRationale":{"summary":"Skill has warnings: 1 warning in security or structure checks.","verdict":"warn","scanners":[{"source":"vettd","weight":1,"verdict":"warn"},{"source":"cisco","weight":0.8,"verdict":"pass"}],"consensus":"warn","warnTriggers":["References external URL — review for indirect prompt injection risk"],"policyVersion":"consensus-v1","hardFailTriggers":[]},"verdictPolicyVersion":"consensus-v1","skillId":"cms7pjr8806t8ad0h6zprgr2o","findings":[{"id":"cmuxm4ng2272sad074butjt9d","source":"vettd","category":"security","label":"References external URL — review for indirect prompt injection risk","detail":"External URL(s) detected in references/art-of-readme.md — referenced content can change after audit","severity":"medium","ruleId":"VTD-0088","owaspLlmCategory":null,"intent":null,"chainId":null,"fingerprint":"2ec081bf7bff945bb8503949c9277911","filepath":"references/art-of-readme.md"},{"id":"cmuxm4ng2272tad073emxbsdh","source":"cisco","category":"security","label":"Skill does not specify a license","detail":"SKILL.md — Skill manifest does not include a 'license' field. Specifying a license helps users understand usage terms.","severity":"info","ruleId":"MANIFEST_MISSING_LICENSE","owaspLlmCategory":null,"intent":null,"chainId":null,"fingerprint":"592f7ac7731768f0fd0bba83f30850f9","filepath":"SKILL.md"}],"scannerRuns":[{"source":"cisco","status":"success","verdict":null,"grade":"A","findingCount":1,"criticalCount":0,"highCount":0},{"source":"vettd","status":"success","verdict":null,"grade":"B","findingCount":1,"criticalCount":0,"highCount":0}],"user":{"name":"Justin Pacella","image":"https://avatars.githubusercontent.com/u/97124458?v=4"},"repository":{"owner":"softaworks","name":"agent-toolkit"},"freshness":{"status":"verified_unchanged","reason":null,"retryable":false,"renamedTo":null,"lastCheckedAt":"2026-10-21T13:35:54.877Z","lastVerifiedAt":"2026-10-21T13:35:54.877Z","lastChangeDetectedAt":null,"scannedHash":"72e2a4d89c5a14b762cfc58e3bbd7fd63e9642b0","latestUpstreamHash":"72e2a4d89c5a14b762cfc58e3bbd7fd63e9642b0","nextCheckDueAt":"2026-10-22T15:40:46.230Z"},"signalCategories":[{"category":"safety","label":"Safety","form":"graded","verdict":null,"rows":[]},{"category":"reliability","label":"Reliability & Quality","form":"graded","verdict":null,"rows":[]},{"category":"performance","label":"Performance","form":"measured","verdict":{"form":"measured","magnitudes":[{"ruleId":"performance/static-context-tokens","label":"Static context tokens","value":589,"unit":null,"method":"tiktoken/cl100k_base/skill-md-body"}]},"rows":[{"origin":"signal","id":"cmuxm4nqy275nad0741y9o7al","subjectType":"skill_audit","subjectId":"cmuxm4ng2272rad07eo9smkqf","relatedType":"","relatedId":"","dataCategory":"performance","sourceClass":"scan","source":"vettd","ruleId":"performance/static-context-tokens","severity":null,"label":"Static context tokens","detail":null,"valueNum":589,"valueText":null,"unit":null,"method":"tiktoken/cl100k_base/skill-md-body","derivation":null,"confidence":null,"sampleSize":null,"synthetic":false,"firstParty":true,"observedAt":"2026-10-07T04:33:49.000Z","payload":null},{"origin":"signal","id":"cmuxm4ou427ecad07fbm66k7p","subjectType":"skill_audit","subjectId":"cmuxm4ng2272rad07eo9smkqf","relatedType":"","relatedId":"","dataCategory":"performance","sourceClass":"scan","source":"vettd","ruleId":"performance/progressive-disclosure","severity":null,"label":"Progressive disclosure","detail":null,"valueNum":null,"valueText":"absent","unit":null,"method":null,"derivation":"read","confidence":null,"sampleSize":null,"synthetic":false,"firstParty":true,"observedAt":"2026-10-07T04:33:49.000Z","payload":null}]},{"category":"cost","label":"Cost","form":"measured","verdict":null,"rows":[]},{"category":"compatibility","label":"Compatibility","form":"unjudged","verdict":{"form":"unjudged"},"rows":[{"origin":"signal","id":"cmuxm4ntw276jad07wnecvlym","subjectType":"skill_audit","subjectId":"cmuxm4ng2272rad07eo9smkqf","relatedType":"","relatedId":"","dataCategory":"compatibility","sourceClass":"scan","source":"vettd","ruleId":"compatibility/declared-environment-assumptions","severity":null,"label":"Declared environment assumptions","detail":null,"valueNum":null,"valueText":"","unit":null,"method":null,"derivation":"read","confidence":null,"sampleSize":null,"synthetic":false,"firstParty":true,"observedAt":"2026-10-07T04:33:49.000Z","payload":null},{"origin":"signal","id":"cmuxm4ob127b4ad0771ul2ua4","subjectType":"skill_audit","subjectId":"cmuxm4ng2272rad07eo9smkqf","relatedType":"","relatedId":"","dataCategory":"compatibility","sourceClass":"scan","source":"vettd","ruleId":"compatibility/declared-name","severity":null,"label":"Declared skill name","detail":null,"valueNum":null,"valueText":"crafting-effective-readmes","unit":null,"method":null,"derivation":"read","confidence":null,"sampleSize":null,"synthetic":false,"firstParty":true,"observedAt":"2026-10-07T04:33:49.000Z","payload":null}]},{"category":"sentiment","label":"Popularity","form":"unjudged","verdict":null,"rows":[]},{"category":"characteristics","label":"Characteristics","form":"unjudged","verdict":null,"rows":[]}],"signalCount":24,"publisherSupplied":["name","description","author","version","license"]}