این ابزار درست کار نمیکند؟
دربارهٔ ابزار «بج برای README در گیتهاب آنلاین»
این ابزار قطعههای بج Markdown را برای README گیتهاب شما (یا هر مستندات Markdown) میسازد. بجها به صورت بصری وضعیت ساخت، پوشش کد، نسخه بسته، مجوز، دانلودها، حضور اجتماعی و موارد دیگر را نشان میدهند — باعث میشود پروژه شما صیقلی و قابل اعتماد به نظر برسد.
انواع بج رایج شامل بجهای سبک shields.io برای کتابخانهها (نسخه npm، دانلودها)، وضعیت CI (GitHub Actions، CircleCI)، کیفیت کد (Codecov، Coveralls)، صدور مجوز (MIT، Apache-2.0)، و متادیتای پروژه (آخرین کامیت، مشارکتکنندگان) است.
قطعههای تولیدشده Markdown هستند که آماده چسباندن در بالای README شما هستند. اکثر بجها به خدمات خارجی پیوند میخورند که به طور خودکار بهروزرسانی میشوند — بنابراین پس از اضافه شدن، آنها همچنان دادههای زنده را نشان میدهند بدون اینکه شما نیاز به ویرایش فایل داشته باشید.
چطور از این ابزار استفاده کنم؟
چطور README badge برای یک پکیج npm تولید کنم؟
نام پکیج را وارد کنید
«Package name» انتظار نام دقیق پکیج npm را همانطور که publish شده دارد — پکیجهای scoped مانند `@scope/name` مثل unscoped `name` کار میکنند. whitespace خودکار trim میشود.
«اجرا» را بزنید
خروجی یک فیلد `markdown` با سه لینک تصویر shields.io است: نسخهٔ آخرین publish، تعداد download هفتگی و SPDX license. side-by-side بدون line break رندر میشوند.
داده از کجا میآید
هر badge یک URL shields.io است که در زمان رندر به endpointهای registry npm hit میکند. خودکار آپدیت میشود — نیازی نیست با publish نسخهٔ جدید badgeها را دوباره تولید کنید.
سفارشیسازی badge
markdown را مستقیم در بخش بالای README خود بچسبانید. shields متفاوت میخواهید؟ URLهای تولیدشده را ویرایش کنید — shields.io از `?color=blue`، `?style=flat-square`، `?logo=npm` و بسیاری دیگر پشتیبانی میکند. به shields.io برای reference کامل پارامتر مراجعه کنید.