Skip to content

🛡️ Very, very quick script to generate repo badges for blog posts

Notifications You must be signed in to change notification settings

Lissy93/repo-badge-maker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 

Repository files navigation

🛡️ Repo Badge Generator

Quick script to generate embedable badges for a repository
repo-badges.as93.net

About

I made this to quickly generate the project links, for this post: CLI tools you won't be able to live without 🔧

Just a simple script to quickly generate embedable markdown badges to show repository info.
Data is fetched from the GitHub API, and badges are served up using the Shields.io API.
Includes a badge for + link to: the author, the repo + star count, and the language used.
Paste in the URL to a repo, hit 'Generate', and results will be copied to your clipboard.

Deployment

It's just a static HTML page, so serve it with any web server, CDN or static host.
There's a demo hosted on GH Pages, at: lissy93.github.io/repo-badge-maker

Report an Issue

Found something that's not working? Open an issue, and describe the problem, steps to reproduce alond with expected and actual output. If relevant, also include details about your environment. I'll try and fix / respond to any tickets within 48-hours.

Contributing

Contributions of any kind are very welcome, and would be much appreiciated. For Code of Conduct, see Contributor Convent.

To get started, fork the repo, make your changes, add, commit and push the code, then come back here to open a pull request. If you're new to GitHub or open source, this guide or the git docs may help you get started, but feel free to reach out if you need any support.

License

Lissy93/repo-badge-maker is licensed under MIT © Alicia Sykes 2022.
For information, see TLDR Legal > MIT

Expand License
The MIT License (MIT)
Copyright (c) Alicia Sykes <alicia@omg.com> 

Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished 
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included install 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

© Alicia Sykes 2023
Licensed under MIT

Thanks for visiting :)

About

🛡️ Very, very quick script to generate repo badges for blog posts

Topics

Resources

Stars

Watchers

Forks

Languages