trowel-badges v0.1.0

Trowel Badges

The official Trowel Component for badges Badges is a Trowel Component, please refer to the Trowel doc for more informations about how works Trowel Components

Getting Started

Download

You can easily install Trowel Badges by using npm, Yarn or Bower

# With bower
$ bower install trowel-badges

# With npm
$ npm install trowel-badges

# With yarn
$ yarn add trowel-badges

You can also download a zip archive right here.

Installation

Scss

The main scss file to include to your main .scss file is located at the ./src/scss/badges.scss. As a Trowel Component, it also requires two dependencies to compile the scss code. Here an scss installation snippet.

// Trowel Dependencies
@import './path/to/dependencies/trowel-core/src/trowel';

// Trowel Components Badges
@import './path/to/dependencies/trowel-badges/src/scss/badges.scss';

CSS

If you don't want to customize the trowel component in scss you can use the css file available at ./dest/css/badges.css. A minified version is available at the same location.

Usage

to be written

Contributing

If you want to contribute you can checkout the contribution guide over here

License

MIT © Trowel