skilld
All skills
davila7 avatar

/crafting-effective-readmes

@1c194fd
by Daniel Aviladavila7/claude-code-templates32k stars
3,662

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

Ask your Agent

Use this Skill: https://skilld.dev/gh/davila7/claude-code-templates/crafting-effective-readmes

This session only. Nothing lands on disk.

referencesstandard-readme-example-maximal.md

≈397 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Title

banner

GitHub Created At GitHub contributors license standard-readme compliant

This is an example file with maximal choices selected.

This is a long description.

Table of Contents

Security

Any optional sections

Background

Any optional sections

Install

This module depends upon a knowledge of Markdown.

Any optional sections

Usage

Note: The license badge image link at the top of this file should be updated with the correct :user and :repo.

Any optional sections

API

Any optional sections

More optional sections

Contributing

See the contributing file!

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

Any optional sections

License

MIT © Richard McRichface.

Source: SKILL.md on GitHub

Third-party checks

1 warning12d4 checks · Risk SAFE
  • Gen Agent Trust Hub12d

    The skill provides comprehensive templates and guidance for writing, updating, and reviewing project README files tailored to different project types (Open Source, Personal, Internal, Config). It is purely instructional and does not contain any malicious code, dangerous commands, or data exfiltration patterns.

  • Socket12d

    No alerts

  • Snyk12d

    Risk: LOW · No issues

  • Runlayer7mo

    14/14 files flagged

Provenance

Signed by skilld at 1c194fd. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 16 hours ago.

Activeupdated 8 months ago

README badge

README badge for davila7/claude-code-templates/crafting-effective-readmes