AiSkillz

AiSkillz is in preview: browse the catalogue now - skill downloads and subscriptions open soon.

← Back to skills
toolingDownloadAny / model-agnosticLicense: My own work (all rights reserved)

README Generator

Created by CodeCraft LLC

Write and review a README.md that gets a reader from "what is this" to a working first run

Product and technology names are trademarks of their respective owners, used only to identify what this skill covers. CodeCraft LLC is not affiliated with or endorsed by them.

by Jace (@jamick)v1.0.0 · updated 2026-10-16Report copyright infringement

Description

Write and review a README.md that gets a reader from "what is this" to a working first run - section order (one-line description, badges, prerequisites, installation, quick start, configuration, API reference, contributing, license), what to put in and leave out of each, tailoring to libraries, CLIs, web apps, API services and monorepos, configuration tables, keeping the README current with the code, common anti-patterns, and a fill-in template. Use whenever the user asks for a README, project documentation, "document this repo", setup or install instructions, is publishing a package or open-sourcing a project, or the existing README is missing, thin or out of date.

#tooling#readme#generator

Included with all-access

AiSkillz is in preview: browse the catalogue now - skill downloads and subscriptions open soon.

All skills are included with the all-access subscription

Changelog

v1.0.0Oct 16, 2026Latest

Added

  • First release.