Agent skill

Readme

by LennartHennigs in LennartHennigs/Button2

Audit README.md against the current Button2 API and recent CHANGELOG entries, then apply any needed updates

MITAuto-check passedDevelopment

Install Readme

skills CLI
$ npx skills add LennartHennigs/Button2 --skill readme -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install LennartHennigs/Button2 readme --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/LennartHennigs/Button2.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/readme .claude/skills/readme && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
readme
GitHub stars
565
Token cost
~372 tokens
SKILL.md length
204 words
Files
1
Skills in repo
4
Repo updated
First seen
Licence
MIT

At a glance

Audit README.md against the current Button2 API and recent CHANGELOG entries, then apply any needed updates

  • Works in 4 steps: Gather context → Identify gaps → Propose changes → …
  • Tasks that involve Technical documentation
  • SKILL.md covers Step 1: Gather context, Step 2: Identify gaps, Step 3: Propose changes and Step 4: Apply updates
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Readme is an agent skill from LennartHennigs/Button2. Audit README.md against the current Button2 API and recent CHANGELOG entries, then apply any needed updates

Its SKILL.md is about 370 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation, Changelog and release notes and Embedded systems. The repository describes itself as: Arduino/ESP button library that provides callback functions to track single, double, triple and long clicks. It also takes care of debouncing. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation
  • Tasks that involve Changelog and release notes
  • Tasks that involve Embedded systems

Example prompts

  • “/readme”

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. Gather context
  2. Identify gaps
  3. Propose changes
  4. Apply updates

What it can do on your machine

Read from SKILL.md and the folder at commit 2f8ba6a. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Readme loads about 372 tokens when it runs. Until then it costs about 29 tokens; SKILL.md has 204 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~29
When it runs · the whole SKILL.md, loaded when a task matches
~372

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from LennartHennigs/Button2 at commit 2f8ba6a, republished under its MIT licence (© LennartHennigs). 204 words, ~372 tokens.

Download SKILL.mdSave it as .claude/skills/readme/SKILL.md (or your agent's skills folder).
name
readme
description
Audit README.md against the current Button2 API and recent CHANGELOG entries, then apply any needed updates

Audit and update README.md to reflect the current state of the library.

Step 1: Gather context

  • Read src/Button2.h — extract every public method signature and constant
  • Read the ## Unreleased and most recent versioned section of CHANGELOG.md
  • Read README.md in full

Step 2: Identify gaps

Compare the public API in Button2.h against what README documents. Flag:

  • Public methods present in the header but missing or outdated in README
  • Methods in README that no longer exist in the header
  • Default values or timing constants in README that differ from the header
  • New features mentioned in CHANGELOG that have no README coverage

Do not flag internal helpers, private methods, or test infrastructure.

Step 3: Propose changes

List each gap with a one-line description of what needs to change. If $ARGUMENTS contains "audit", stop here and show the list without editing.

Step 4: Apply updates

For each gap, edit README.md in place:

  • Match the existing style, formatting, and section structure exactly
  • For new API entries, insert them in the same section and format as adjacent entries
  • For removed entries, delete them cleanly without leaving stubs or comments
  • Keep code examples consistent with the Arduino/ESP conventions in the file (no STL, no smart pointers)

Report what was changed when done.

© LennartHennigs, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/readme of LennartHennigs/Button2.

Open the folder on GitHubat commit 2f8ba6a

Compare with similar skills

Readme next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Readme compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Readme this skillLennartHennigs/Button2565—~372Automated safety check: PassMIT
CommitLennartHennigs/ESPRotary188—~590Automated safety check: PassMIT
ReadmeLennartHennigs/ESPRotary188—~417Automated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Ccb GitHubSeemSeam/claude_codex_bridge3.6k—~4.9kAutomated safety check: PassCustom licence
Golang Documentationunxed/f42433 repos~3.5kAutomated safety check: PassMIT

Similar skills

  • Commit

    LennartHennigs/ESPRotary

    Stage and commit current changes for ESPRotary — checks for needed CHANGELOG/README/CLAUDE.md updates, creates a branch if on master, writes a commit message, and commits

    188 GitHub stars~590 tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Readme

    LennartHennigs/ESPRotary

    Audit README.md against the current ESPRotary API and recent CHANGELOG entries, then apply any needed updates

    188 GitHub stars~417 tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Ccb GitHub

    SeemSeam/claude_codex_bridge

    Maintain this CCB project's GitHub-facing release and npm publication surface.

    3.6k GitHub stars~4.9k tokensUpdated today
    DevelopmentAuto-check passed
  • Comprehensive documentation guide for Golang projects, covering godoc comments, README, CONTRIBUTING, CHANGELOG, Go Playground, Example tests, API docs, and llms.txt.

    243 GitHub starsUsed in 3 repos~3.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    ropensci/ckanr

    Write or rewrite text in plain, layman-readable English in the spirit of ASD-STE100 Simplified Technical English: short sentences, active voice, simple tenses, one word one meaning, condition before…

    104 GitHub starsUsed in 3 repos~2k tokens
    DevelopmentAuto-check passed

More from LennartHennigs/Button2

  • Commit

    LennartHennigs/Button2

    Stage and commit current changes for Button2 — checks for needed CHANGELOG/README/CLAUDE.md updates, creates a branch if on master, writes a commit message, and commits

    565 GitHub stars~562 tokensUpdated 4 mo ago
    Auto-check passed
  • Release

    LennartHennigs/Button2

    Cut a new Button2 release — suggests version bump based on change type, updates version files and CHANGELOG, commits, tags, pushes, creates a GitHub release, and publishes to PlatformIO

    565 GitHub stars~519 tokensUpdated 4 mo ago
    Auto-check passed
  • Compile

    LennartHennigs/Button2

    Compile Button2 examples across Arduino platforms using arduino-cli and PlatformIO.

    565 GitHub stars~221 tokensUpdated 4 mo ago
    Auto-check passed

Categories

Questions about Readme

What does Readme do?

Audit README.md against the current Button2 API and recent CHANGELOG entries, then apply any needed updates. Readme is an agent skill from LennartHennigs/Button2.

When should I use Readme?

Readme fits situations like: tasks that involve Technical documentation; tasks that involve Changelog and release notes; tasks that involve Embedded systems.

How do I install Readme in Claude Code?

Run `npx skills add LennartHennigs/Button2 --skill readme -a claude-code`. Or copy the skill folder (.claude/skills/readme in LennartHennigs/Button2) into .claude/skills/readme in your project. Claude Code loads it when a task matches its description.

How do I install Readme in Codex?

Run `npx skills add LennartHennigs/Button2 --skill readme -a codex`. Or copy the skill folder (.claude/skills/readme in LennartHennigs/Button2) into .agents/skills/readme in your project. Codex loads it when a task matches its description.

Can I use Readme in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add LennartHennigs/Button2 --skill readme -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme, .gemini/skills/readme, .github/skills/readme and .opencode/skills/readme in your project.

What does Readme need to run?

SKILL.md names no scripts, command-line tools or credentials: Readme is instructions for the agent only.

Does Readme access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Readme safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Readme use?

Readme is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Readme use?

About 372 tokens (SKILL.md is roughly 1.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Readme?

Skills that share tags, products or a category with Readme: Commit (LennartHennigs/ESPRotary, 188 stars), Readme (LennartHennigs/ESPRotary, 188 stars), Simple English (moeru-ai/airi, 50k stars) and Ccb GitHub (SeemSeam/claude_codex_bridge, 3.6k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme?

LennartHennigs (a GitHub user) maintains it in LennartHennigs/Button2, which has 565 GitHub stars. The repository holds 4 skills in this directory. The repository was last updated on June 6, 2026.

Source: LennartHennigs/Button2 on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.