Przejdź do treści
Biblioteka skilli
Produktywność osobista · Budowanie i kod

readme-maker

/readme-maker

Projektuje profilowe README na GitHubie z szablonów, sprawdza odznaki i generuje widżety statystyk.

Repozytorium
SkillCamo ↗
Licencja
Apache-2.0
Ostatnia zmiana repozytorium
04.11.2026

Ocena i bezpieczeństwo

95/ 100Klasa: dobry
Format20 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
3
Skrypty
1
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 04.11.2026, bez odwołań do wycofanych modeli i API.

Licencja

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

Co sprawdzić przed instalacją
  • 1 skrypt w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.

Skrypty: scripts/script.sh

Co robi i kiedy

Projektuje profilowe README na GitHubie z szablonów, sprawdza odznaki i generuje widżety statystyk.

Oryginalny opis (EN)

Design beautiful GitHub profile READMEs with templates. Use when styling profiles, validating badges, generating stat widgets, formatting bio sections.

Jak działa

  1. Commands
  2. Data Storage
  3. Requirements
  4. When to Use
  5. Examples
  6. Output
  7. Configuration
Sekcje z nagłówków SKILL.md, w oryginale · 108 linii, 643 słów
Podgląd SKILL.md
---
version: "2.0.0"
name: readme-maker
description: "Design beautiful GitHub profile READMEs with templates. Use when styling profiles, validating badges, generating stat widgets, formatting bio sections."
---

# Readme Maker

Developer tools CLI for checking, validating, generating, and formatting README files and documentation. Lint your markdown, generate templates, convert between formats, diff versions, preview output, fix common issues, and produce reports — all from the command line with persistent local logging.

## Commands

Run `readme-maker <command> [args]` to use.

| Command | Description |
|---------|-------------|
| `check` | Check README files for completeness and common issues |
| `validate` | Validate markdown structure and formatting rules |
| `generate` | Generate README content from project metadata |
| `format` | Format and beautify markdown content |
| `lint` | Lint markdown for style and syntax issues |
| `explain` | Explain markdown elements or README sections |
| `convert` | Convert between documentation formats |
| `template` | Apply or manage README templates |
| `diff` | Diff two README versions or sections |
| `preview` | Preview rendered markdown output |
| `fix` | Auto-fix common README issues |
| `report` | Generate documentation quality reports |
| `stats` | Show summary statistics across all categories |
| `export <fmt>` | Export data in json, csv, or txt format |
| `search <term>` | Search across all logged entries |
| `recent` | Show recent activity from history log |
| `status` | Health check — version, data dir, disk usage |
| `help` | Show help and available commands |
| `version` | Show version (v2.0.0) |

Each domain command (check, validate, generate, etc.) works in two modes:
- **Without arguments**: displays the most recent 20 entries from that category
- **With arguments**: logs the input with a timestamp and saves to the category log file

## Data Storage

All data is stored locally in `~/.local/share/readme-maker/`:

- Each command creates its own log file (e.g., `check.log`, `generate.log`, `lint.log`)
- A unified `history.log` tracks all activity across commands
- Entries are stored in `timestamp|value` pipe-delimited format
- Export supports JSON, CSV, and plain text formats

## Requirements

- Bash 4+ with `set -euo pipefail` strict mode
- Standard Unix utilities: `date`, `wc`, `du`, `tail`, `grep`, `sed`, `cat`
- No external dependencies or API keys required

## When to Use

1. **Starting a new project** — generate a README from a template, then lint and format it to ensure quality before committing
2. **Auditing existing documentation** — check and validate your README for missing sections (license, contributing, install instructions) and auto-fix common issues
3. **Converting documentation formats** — convert README content between markdown, reStructuredText, or other formats as part of a docs pipeline
4. **Comparing README changes** — diff two versions of your README to review what changed across releases or branches
5. **CI/CD documentation quality gates** — integrate lint and validate commands into your pipeline to enforce documentation standards on every PR

## Examples

```bash
# Check a README for completeness
readme-maker check "missing: license section, contributing guide, badges"

# Validate markdown structure
readme-maker validate "## headers OK, links 3/3 valid, images 1/1 accessible"

# Generate README from project info
readme-maker generate "name=my-app lang=python license=MIT"

# Lint for style issues
readme-maker lint "line 42: trailing whitespace; line 58: no blank line before heading"

# Format markdown content
readme-maker format "normalized headings, fixed list indentation, wrapped at 80 cols"

# Apply a template
readme-maker template "minimal — added: title, description, install, usage, license"

# Preview rendered output
readme-maker preview "rendered 128 lines, 3 code blocks, 2 tables"

# View summary statistics
readme-maker stats

# Export all data as JSON
readme-maker export json

# Search for specific entries
readme-maker search "license"
```

## Output

All commands output to stdout. Redirect to a file if needed:

```bash
readme-maker report "weekly audit" > report.txt
readme-maker export csv  # saves to ~/.local/share/readme-maker/export.csv
```

## Configuration

Set `DATA_DIR` by modifying the script, or use the default: `~/.local/share/readme-maker/`

---
Powered by BytesAgain | bytesagain.com | hello@bytesagain.com
Pliki w paczce (3)
  • SKILL.md 4 KB
  • _meta.json 1 KB
  • scripts/script.sh 11 KB

Wersje

W bazie nie ma innych skilli o nazwie readme-maker.

Migawka bazy z 13.11.2026 · wersja paczki f907776353d7 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100configure-readme
    Tworzy README.md z logo, odznakami, listą funkcji i sekcją stosu technologicznego, audytuje brakujące sekcje i dodaje odznaki shields.io.
  • 100readme-generator-free
    Generuje README, dokumentację instalacji i użycia oraz odznaki dla projektu na podstawie istniejącego kodu.
  • 100github-glowup
    Ocenia profil GitHub kandydata oczami rekruterów, przygotowuje poprawki README i opisów, stosuje je po zgodzie.
  • 100add-badges
    Wykrywa stos technologiczny i generuje odznaki shields.io do README z ikonami, kolorami i aktualnymi endpointami.
  • 100github-readme
    Projektuje README GitHub: wyśrodkowany nagłówek, rzetelne odznaki, diagramy Mermaid, wykresy z danych i obrazy dla jasnego i ciemnego motywu.
  • 96create-readme
    Generuje lub aktualizuje plik README.md albo CHANGELOG.md projektu.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.