Skip to content

Latest commit

 

History

History
124 lines (107 loc) · 4.15 KB

README.md

File metadata and controls

124 lines (107 loc) · 4.15 KB
Raw

badger-cli

Quickly generate metadata badges in terminal



Built with ❤︎ by tiaanduplessis and contributors

Table of Contents

Table of Contents
  • About
  • Install
  • Usage
  • Contribute
  • License

    • About

    CLI just wraps badge-studio.

    Install

    $ npm install badger-cli
# OR
$ yarn add badger-cli

    Usage

    $ badger --subject=build --status=passing
#<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="88" height="20">
#  <linearGradient id="smooth" x2="0" y2="100%">
#    <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
#    <stop offset="1" stop-opacity=".1"/>
#  </linearGradient>
#
#  <clipPath id="round">
#    <rect width="88" height="20" rx="3" fill="#fff"/>
#  </clipPath>
#
#  <g clip-path="url(#round)">
#    <rect width="37" height="20" fill="#555"/>
#    <rect x="37" width="51" height="20" fill="#4c1"/>
#    <rect width="88" height="20" fill="url(#smooth)"/>
#  </g>
#
#  <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
#
#
#    <text x="18.5" y="15" fill="#010101" fill-opacity=".3">build</text>
#
#    <text x="18.5" y="14" fill="#fff">build</text>
#
#    <text x="61.5" y="15" fill="#010101" fill-opacity=".3">passing</text>
#
#    <text x="61.5" y="14" fill="#fff">passing</text>
#  </g>
#</svg>

    Possible arguments:

    • --subject
    • --status
    • --logo

    Contributing

    Contributions are welcome!

    1. Fork it.
    2. Create your feature branch: git checkout -b my-new-feature
    3. Commit your changes: git commit -am 'Add some feature'
    4. Push to the branch: git push origin my-new-feature
    5. Submit a pull request :D

    Or open up a issue.

    License

    Licensed under the MIT License.