Ada masalah dengan alat ini?

Tentang «Readme Badges Generator Online»

Alat ini membangun cuplikan badge Markdown untuk README GitHub Anda (atau dokumentasi Markdown apa pun). Badge secara visual menunjukkan status build, cakupan kode, versi paket, lisensi, unduhan, kehadiran sosial dan lainnya — membuat proyek Anda terlihat dipoles dan terpercaya.

Jenis badge umum termasuk badge gaya shields.io untuk library (versi npm, unduhan), status CI (GitHub Actions, CircleCI), kualitas kode (Codecov, Coveralls), lisensi (MIT, Apache-2.0), dan metadata proyek (commit terakhir, kontributor).

Cuplikan yang dihasilkan adalah Markdown siap untuk ditempel di bagian atas README Anda. Sebagian besar badge ditautkan ke layanan eksternal yang diperbarui secara otomatis — jadi setelah ditambahkan, mereka terus menampilkan data langsung tanpa Anda perlu mengedit file.

Cara memakai alat ini

Cara menghasilkan badge README untuk paket npm

  1. Nama paket

    "Package name" mengharapkan nama paket npm yang dipublikasikan persis — paket bertopik `@scope/name` bekerja seperti `name` biasa. Spasi otomatis di-trim.

  2. Tekan Jalankan

    Hasil: satu field `markdown` berisi tiga gambar shields.io: versi terakhir yang dipublikasikan, jumlah unduhan mingguan, dan lisensi SPDX. Dirender berdampingan tanpa pemisah baris.

  3. Dari mana datanya

    Setiap badge adalah URL shields.io yang memukul endpoint registry npm saat rendering. Otomatis diperbarui — Anda tidak perlu menyusun ulang badge ketika merilis versi baru.

  4. Menyesuaikan badge

    Tempel markdown langsung di bagian atas README. Mau gaya lain? Edit URL yang dihasilkan — shields.io mendukung `?color=blue`, `?style=flat-square`, `?logo=npm` dan banyak lagi. Lihat shields.io untuk referensi parameter lengkap.

Alat serupa