How do I install the Readme skill?

Run npx skillmds@latest add bitsocialnet/readme-6 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Readme skill do?

Create or edit requested README content while verifying package API, examples, and commands. It is listed under Integrations & APIs on SkillMD.

Is Readme safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readme?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readme free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readme?

bitsocialnet (@bitsocialnet) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readme by bitsocialnet — Agent Skill

Name: Readme
Author: bitsocialnet

File contents

README

Update the requested section in place, preserving unrelated content and tone. A small edit needs only supporting sources; research the full library when a new README or comprehensive rewrite is requested.

Verify public API claims against src/index.ts, src/types.ts, and relevant hooks/stores/tests. Use @bitsocial/bitsocial-react-hooks in import examples and preserve supported React versions, store-driven data flow, and loading/error behavior. Verify installation and test commands against package.json and current configuration.

For a new README, explain installation, a minimal working hook example, relevant API usage, testing/contribution commands, and license as appropriate for the audience. Do not expand a focused correction into a full API catalog or invent troubleshooting advice.

Follow docs/agent-playbooks/verification.md for document checks and regenerate llms*.txt when required. Commit/publish only within the user's authorization and report any unverified claim.

Frequently asked questions

Readme