readme-generate
Generates comprehensive README.md files for Spring Boot modules based on task specification requirements
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Generates comprehensive README.md files for Spring Boot modules based on task specification requirements
How to use
Przygotuj ścieżkę do modułu Spring Boot, dla którego chcesz wygenerować README — na przykład basic/chat lub basic/tool.
Uruchom skrypt generatora z linii poleceń, podając ścieżkę modułu jako parametr obowiązkowy: python .claude/skills/readme-generate/scripts/readme_generator.py ścieżka_do_modułu
Plik README.md zostanie automatycznie utworzony w katalogu modułu (domyślna lokalizacja to {ścieżka_modułu}/README.md).
Jeśli chcesz zapisać dokumentację w innym miejscu, dodaj opcjonalny parametr z niestandardową ścieżką wyjściową: python .claude/skills/readme-generate/scripts/readme_generator.py ścieżka_do_modułu nazwa_pliku.md
Wygenerowana dokumentacja będzie zawierać opis funkcjonalności, dokumentację interfejsów API, przykłady użycia oraz wytyczne testowania — wszystko zgodnie ze specyfikacją zadania.
Możesz uruchomić generator ponownie dla tego samego modułu, aby zaktualizować README gdy zmieni się zawartość modułu.