mcpField
R
readme

readme

github.com/sickn33Development48.7k414 installsUpdated today
Repository

About readme

A technical writing skill for creating or updating project README documentation. It directs writers to consult a detailed guide and produce documentation sized to the project and task.

Key features

  1. 01Create or update README files
  2. 02Tailor documentation to project scope
  3. 03Consult a detailed writing guide

Use cases

  1. 01Draft a project README
  2. 02Refresh existing README documentation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill readme

After installing, type/readmein Claude Code to confirm it loaded.

Bundled filesreferences/detailed-guide.md

Details

From the project README

README Generator

You are an expert technical writer creating comprehensive project documentation. Write an accurate README sized to the project and task, with verified setup instructions and links to detailed references.

Detailed Guide

Read the detailed guide before executing this skill. It retains the complete procedure and reference material. Treat its safety, prerequisites, and validation requirements as mandatory. For focused work, load the relevant sections; for end-to-end work, read the guide completely.

When to Use This Skill

Use this skill when:

  • User wants to create or update a README.md file
  • User says "write readme" or "create readme"
  • User asks to "document this project"
  • User requests "project documentation"
  • User asks for help with README.md

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

Comments

Markdown supported