trowel-covers
Version:
The official Trowel Component for covers
59 lines (41 loc) • 2.14 kB
Markdown
# Trowel Covers
[](https://badge.fury.io/js/trowel)
[](https://badge.fury.io/bo/trowel-Cover)
The official Trowel Component for covers
Covers is a *Trowel Component*, please refer to the [Trowel doc](https://github.com/Trowel/Trowel/blob/master/doc/1-the-concept.md) for more informations about how works *Trowel Components*
## Getting Started
### Download
You can easily install *Trowel Covers* by using npm, Yarn or Bower
```bash
# With bower
$ bower install trowel-covers
# With npm
$ npm install trowel-covers
# With yarn
$ yarn add trowel-covers
```
You can also download a zip archive [right here](https://github.com/FriendsOfTrowel/Covers/archive/master.zip).
### Installation
#### *Scss*
The main scss file to include to your main `.scss` file is located at the `./src/scss/covers.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 Covers
@import './path/to/dependencies/trowel-covers/src/scss/covers.scss';
```
#### *CSS*
If you don't want to customize the trowel component in `scss` you can use the css file available at `./dest/css/covers.css`. A minified version is available at the same location.
#### *JavaScript*
You have several javascript files for different use cases :
* The browser ready file is available at `./dest/javascript/covers.js` (a minified version exists at `dest/javascript/covers.min.js`)
* The script written in es2015 and ready to `import` is available at `./src/javascript/covers.js`
#### *Twig template*
The twig template is located at the `./src/twig/cover.html.twig`.
## Usage
to be written
## Contributing
If you want to contribute you can checkout the contribution guide [over here](CONTRIBUTING.md)
## License
MIT © [Trowel](trowel.github.io)