Skip to content

BADGES.md

Latest commit

 

History

History
202 lines (129 loc) · 6.07 KB

BADGES.md

File metadata and controls

202 lines (129 loc) · 6.07 KB

SpecLock README Badges

Protected by SpecLock — Show the world your AI coding tools respect your rules.

Add one (or all) of these to the top of your README.md. Every badge links back to SpecLock so visitors can learn why your repo can't be wrecked by a rogue prompt.

Browse live previews: https://sgroy10.github.io/speclock/badge.html

After running speclock protect, you can also run speclock badge to print these straight to your terminal.

1. Standard Shield

Protected by SpecLock

Markdown

[![Protected by SpecLock](https://img.shields.io/badge/Protected_by-SpecLock-FF6B2C?style=flat&logo=lock)](https://github.com/sgroy10/speclock)

HTML

<a href="https://github.com/sgroy10/speclock"><img src="https://img.shields.io/badge/Protected_by-SpecLock-FF6B2C?style=flat&logo=lock" alt="Protected by SpecLock"></a>

reStructuredText

.. image:: https://img.shields.io/badge/Protected_by-SpecLock-FF6B2C?style=flat&logo=lock
   :target: https://github.com/sgroy10/speclock
   :alt: Protected by SpecLock

Where to put it: Top of your README.md, right under the title.

2. Flat Square

Protected by SpecLock

Markdown

[![Protected by SpecLock](https://img.shields.io/badge/Protected_by-SpecLock-FF6B2C?style=flat-square&logo=lock)](https://github.com/sgroy10/speclock)

HTML

<a href="https://github.com/sgroy10/speclock"><img src="https://img.shields.io/badge/Protected_by-SpecLock-FF6B2C?style=flat-square&logo=lock" alt="Protected by SpecLock"></a>

reStructuredText

.. image:: https://img.shields.io/badge/Protected_by-SpecLock-FF6B2C?style=flat-square&logo=lock
   :target: https://github.com/sgroy10/speclock
   :alt: Protected by SpecLock

Where to put it: Alongside your other flat-square shields (npm, license, downloads).

3. For the Badge

Protected by SpecLock

Markdown

[![Protected by SpecLock](https://img.shields.io/badge/PROTECTED_BY-SPECLOCK-FF6B2C?style=for-the-badge&logo=lock&logoColor=white)](https://github.com/sgroy10/speclock)

HTML

<a href="https://github.com/sgroy10/speclock"><img src="https://img.shields.io/badge/PROTECTED_BY-SPECLOCK-FF6B2C?style=for-the-badge&logo=lock&logoColor=white" alt="Protected by SpecLock"></a>

reStructuredText

.. image:: https://img.shields.io/badge/PROTECTED_BY-SPECLOCK-FF6B2C?style=for-the-badge&logo=lock&logoColor=white
   :target: https://github.com/sgroy10/speclock
   :alt: Protected by SpecLock

Where to put it: Hero section of a landing-page README, or centerpiece under your project name.

4. Dynamic Version (auto-updates)

SpecLock

Markdown

[![SpecLock](https://img.shields.io/npm/v/speclock?label=SpecLock&color=FF6B2C&logo=lock)](https://www.npmjs.com/package/speclock)

HTML

<a href="https://www.npmjs.com/package/speclock"><img src="https://img.shields.io/npm/v/speclock?label=SpecLock&color=FF6B2C&logo=lock" alt="SpecLock"></a>

reStructuredText

.. image:: https://img.shields.io/npm/v/speclock?label=SpecLock&color=FF6B2C&logo=lock
   :target: https://www.npmjs.com/package/speclock
   :alt: SpecLock

Where to put it: Next to your other npm version shields. Signals you track SpecLock releases.

5. Tests Passing

Tests

Markdown

[![Tests](https://img.shields.io/badge/SpecLock_Tests-1009%20passing-success)](https://github.com/sgroy10/speclock)

HTML

<a href="https://github.com/sgroy10/speclock"><img src="https://img.shields.io/badge/SpecLock_Tests-1009%20passing-success" alt="Tests"></a>

reStructuredText

.. image:: https://img.shields.io/badge/SpecLock_Tests-1009%20passing-success
   :target: https://github.com/sgroy10/speclock
   :alt: Tests

Where to put it: Build-status row alongside your own CI badges.

6. Downloads

Downloads

Markdown

[![Downloads](https://img.shields.io/npm/dm/speclock?label=SpecLock%20downloads&color=FF6B2C)](https://www.npmjs.com/package/speclock)

HTML

<a href="https://www.npmjs.com/package/speclock"><img src="https://img.shields.io/npm/dm/speclock?label=SpecLock%20downloads&color=FF6B2C" alt="Downloads"></a>

reStructuredText

.. image:: https://img.shields.io/npm/dm/speclock?label=SpecLock%20downloads&color=FF6B2C
   :target: https://www.npmjs.com/package/speclock
   :alt: Downloads

Where to put it: Social-proof row near the top of your README.

Stack them all

[![Protected by SpecLock](https://img.shields.io/badge/Protected_by-SpecLock-FF6B2C?style=flat&logo=lock)](https://github.com/sgroy10/speclock)
[![SpecLock](https://img.shields.io/npm/v/speclock?label=SpecLock&color=FF6B2C&logo=lock)](https://www.npmjs.com/package/speclock)
[![Tests](https://img.shields.io/badge/SpecLock_Tests-1009%20passing-success)](https://github.com/sgroy10/speclock)
[![Downloads](https://img.shields.io/npm/dm/speclock?label=SpecLock%20downloads&color=FF6B2C)](https://www.npmjs.com/package/speclock)

Why add a badge?

  • Trust signal. Visitors know your codebase is protected by an AI constraint engine, not vibes.
  • Marketing for the ecosystem. Every badge helps other developers discover SpecLock and keep their own projects safe.
  • Proof you care. You care enough about your rules to enforce them, not just document them.

If SpecLock saves your project from a 3am incident, please add a badge. It costs you nothing and helps the community.

Generated by the SpecLock team. Developed by Sandeep Roy.