https://github.com/dahlia/fedi-badge

A badge generator for ActivityPub-enabled social media platforms, i.e., fediverse
https://github.com/dahlia/fedi-badge

activitypub badge badge-generator fediverse

Last synced: 24 days ago
JSON representation

A badge generator for ActivityPub-enabled social media platforms, i.e., fediverse

• Host: GitHub
• URL: https://github.com/dahlia/fedi-badge
• Owner: dahlia
• License: agpl-3.0
• Created: 2024-03-20T15:26:44.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-28T04:00:33.000Z (about 1 month ago)
• Last Synced: 2024-10-03T16:35:41.190Z (about 1 month ago)
• Topics: activitypub, badge, badge-generator, fediverse
• Language: TypeScript
• Homepage: https://fedi-badge.deno.dev/
• Size: 27.3 KB
• Stars: 37
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Fedi badge

==========

This is a simple badge generator for ActivityPub-enabled social media platforms,

i.e., fediverse.  It is inspired by [Shields.io] and is intended to be used in

a similar way.  It does not support only Mastodon, but also other platforms like

Pleroma, Misskey, Pixelfed, and so on.[^1]

Here is an example of a fedi badge:

https://fedi-badge.deno.dev/@[email protected]/followers.svg

![Follow @[email protected]](https://fedi-badge.deno.dev/@[email protected]/followers.svg)

The pattern of the URL is:

    https://fedi-badge.deno.dev/@USER@DOMAIN/followers.svg

    https://fedi-badge.deno.dev/@USER@DOMAIN/following.svg

    https://fedi-badge.deno.dev/@USER@DOMAIN/posts.svg

Optionally, you can specify the following options in the query string:

 -  `label`: The label of the badge.  If not specified, it will be automatically

    *Follow @USER@DOMAIN*.

 -  `style`: The style of the badge.  It can be one of `plastic`, `flat`,

    `flat-square`, `for-the-badge`, `social`.  If not specified, it will be

    `social`.

Example:

    https://fedi-badge.deno.dev/@USER@DOMAIN/followers.svg?style=flat

Note that each badge is cached for an hour, so you may not see the immediate

change after your social media activity.

[^1]: Unless you configured your following/followers to be private.

[Shields.io]: https://shields.io/