setup-badge 1.0.0

No project description provided

setup-badge

😎 Why you need setup-badge?

setup-badge empowers you to create dynamic and static endpoint badges to showcase on your README file.

In a dynamic badge, the message changes over time. For instance, code coverage percentage and software version. In a static badge, the message does not change regularly over time. For instance, license and programming language.

p.s. message refers to the right side of a badge

✨ Summary of running the above commands

• badges branch can hold multiple JSON files.
• badges folder can hold json files from different branches.

🔔 What is next after creating the endpoint badge?

• copy and paste to your README file
• write a commit and merge your code

🔧 setup-badge command line options

Input	Description	Default	Notes
badge-name	JSON endpoint filename	badge	JSON endpoint filename
branch-name	Branch to hold JSON endpoint	badges	a single branch can hold multiple JSON endpoint files
badge-style	Badge style	flat	other options: flat-square, plastic, for-the-badge, social
badge-url	Badge URL	''	no default value (enter a url if necessary)
label	Left side text	demo	-
label-color	Left side background color	2e2e2e	hex color
message	Right side text	no status	place dynamic/static data here
message-color	Right side background color	2986CC	hex color
remote-name	Git remote source branch	origin	leave it as-is in general
gitconfig-name	Git config user name	Mona Lisa	need this option for CI or GitHub action
gitconfig-email	Git config user email	[e-mail]	need this option for CI or GitHub action

😕 Troubleshooting

Open an issue

🙏 Contributing

Pull requests and stars are always welcome. For pull requests to be accepted on this project, you should follow PEP8 when creating/updating Python codes.

See Contributing

📚 References

Shields.io Endpoint Badge

Hex Color

How to fork a repo