इस प्रोजेक्ट के बारे में

यह रिपॉजिटरी Shields.io का घर है, जो SVG और रास्टर प्रारूप में संक्षिप्त, सुसंगत और सुपाठ्य बैज के लिए एक सेवा है। README कहता है कि बैज GitHub readmes या किसी अन्य वेब पेज में एम्बेड किए जा सकते हैं। यह बताता है कि सेवा दर्नों continuous integration सेवाओं, package registries, distributions, app stores, social networks, code coverage services और code analysis services का समर्थन करती है। यह कहता है कि हर महीने यह 1.6 बिलियन से अधिक इमेज सर्व करती है और VS Code, Vue.js और Bootstrap जैसी परियोजनां इसका उपयोग करती हैं। रेपो में Shields.io frontend और server कोड, बैज बनाने के लिए एक NPM लाइब्रेरी जिसे badge-maker कहा जाता है, और badge design specification होस्ट हैं। सूचीबद्ध उदाहरणों में code coverage percentage, stable release version, package manager release, dependency status, static code analysis grade, SemVer version, weekly Liberapay donations, Python package downloads, Chrome Web Store extension rating और Uptime Robot uptime percentage शामिल हैं। उपयोगकर्ता एक URL pattern के सा custom badges बना सकते हैं। README एक quickstart का वर्णन करता है जहां उपयोगकर्ता बैज की पूरी सूची ब्राज़ करते हैं, श्रेणियों को खोजते या ब्राउज़ करते हैं, आवश्यक डेटा जैसे username या repo भरने के लिए बैज पर क्लिक करते हैं, वैकल्पिक रूप से label और colors customize करते हैं, फिर GitHub readmes या अन्य वेब पेजों के लिए badge URL या snippet कॉपी करते हैं। योगदान issues और pull requests के माध्यम से समुदाय-आधारित है; README योगदानकर्ताओं से कहता है कि सेवा जोड़ते या बदलते समय परीक्षण जोड़ें, और बैज जोड़ने पर एक tutorial की ओर इशारा करता है। यह good first issues और एक security policy का भी उल्लेख करता है। विकास के लिए, README में Node 24 स्थापित करना, रिपॉजिटरी क्लोन करना, npm ci, npm start चलाना, और localhost:3000 खोलना सूचीबद्ध है। Server source परिवर्तन nodemon के माध्यम से पुनः आरंभ होते हैं, जबकि frontend परिवर्तन Docusaurus dev server के माध्यम से reload होते हैं; badge definitions पहले server start से पहले build होते हैं और npm run prestart या restart से पुनः उत्पन्न किए जा सकते हैं। एक badge को कमांड लाइन से npm run badge के साथ डीबग किया जा सकता है, जिसमें full URLs शामिल हैं। Snapshot tests SVG या JSON output की रक्षा करते हैं; जानबूझकर output परिवर्तनों को SNAPSHOT_DRY=1 npm run test:package के साथ preview किया जा सकता है और SNAPSHOT_UPDATE=1 के साथ update किया जा सकता है। Server वैकल्पिक रूप से Sentry और Prometheus का उपयोग कर सकता है। Self-hosting दस्तावेज़ लिंक किया गया है। संबंधित परियोजनाओं में awesome-badges, एक curated collection शामिल है। README इतिहास देता है: b.adge.me मूल साइट थी, जो gh-badges से 2013 कोड का उपयोग करती थी; परियोजना shields.io के साथ विय हो गई। मूल badge specification 2013 में विकसित की गई थी और बाद में 2014 में फिर से डिज़ाइन की गई थी; पुरानी design को plastic style और नई को flat style कहा जाता है। Maintainers और alumni सूचीबद्ध हैं, और परियोजना MIT और Apache 2.0 के तहत dual licensed है। यह community funding और support से भी लिंक करता है।