Toolverse
All skills

readme-gen

by openclaw

Generate beautiful README.md files with badges, install instructions, and API docs. Use when starting new projects.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Author
openclaw
Category
Backend

About this skill

Generate beautiful README.md files with badges, install instructions, and API docs. Use when starting new projects.

How to use

  1. Otwórz terminal w katalogu Twojego projektu.

  2. Uruchom narzędzie komendą npx ai-readme. Nie wymaga instalacji ani konfiguracji — wszystko działa automatycznie.

  3. Narzędzie przeskanuje strukturę projektu, wygeneruje odznaki, instrukcje instalacji, dokumentację API na podstawie eksportów oraz przykłady użycia.

  4. Jeśli chcesz zapisać wynik w konkretnym pliku, użyj flagi --output README.md. Aby uwzględnić tylko wybrane sekcje, dodaj --sections intro,install,api,examples.

  5. Przejrzyj wygenerowany plik README. Dostosuj wstęp do swojego stylu, zastąp generyczne przykłady rzeczywistymi przypadkami użycia i zmniejsz liczbę odznak do 3–5 najważniejszych.

  6. Zacommituj plik README do repozytorium. Najlepiej uruchomić narzędzie na początku projektu — łatwiej jest utrzymywać README niż pisać go od zera później.

Related skills