Readme

Let agents write structured readmes

Install

npx -y skills add myl7/readme-skill --skill readme

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Use when creating or updating the readme (README.md).

The file declares its own license as Apache-2.0. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

1.9 KB, as published. Nobody here has run it

Template

# Project Name
<!-- If we have a descriptive one, use it. Otherwise, use the project dirname, project-name. -->

[![Badges](...)][...]

One-line description that catches project's highlights
<!-- Say what the project can do (functionality), not how to do (methods).
**No period** if there is only one sentence. Add periods if there are multiple ones.
Texts can be hyperlinked. -->

[Documentation](...)
<!-- If there are external links, e.g., external documentations at docs.rs or github.io, put them here. -->

## Features

- **Feature**: Feature description. Do not include technical details.
- ...
- ...

## Prerequisites

List required dependencies, runtime, or systems.
Include versions if required.

## Get Started

Step-by-step instructions to run project, including installation, configuration, and usage.

## Config

List and explain configuration options.

## Other sections that are useful for users

...

## License
<!-- Always singular -->

Copyright (C) year Holder Name <email> **No period**
<!-- Try reading from ~/.gitconfig. -->

License Name (e.g., Apache License, Version 2.0) **No period**
<!-- Read LICENSE/LICENSE.*, or fallback to the license field of the package manifest (e.g., package.json, Cargo.toml, pyproject.toml, etc.). -->

If a section cannot be provided, e.g., the project has no badges, configuration, or prerequisites, Omit the section but report the action.
Report any action that violates the template.

Style

Readme is for users. Do not include technical details or framework information unless requested.
Write in English by default.
If there exists an old readme that does follow the template, extract information from it and generate the new readme from scratch.