Skip to content

Commit

Permalink
feat(docs): Added README
Browse files Browse the repository at this point in the history
Fixes #1
  • Loading branch information
ariddlestone committed Feb 1, 2020
1 parent fd7d1d9 commit c2a0b76
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Riddlestone Brokkr-Gulpfile

A [Laminas](https://github.com/laminas) module for creating [Gulp](https://gulpjs.com) config files

## Installation

Installation of this module uses composer. For composer documentation, please refer to
[getcomposer.org](http://getcomposer.org/).

```sh
composer require riddlestone/brokkr-gulpfile
```

## Usage

To include your js/sass files in the gulpfile, add them in portals to your module or site's config file:

```php
<?php
return [
'gulp' => [
'portals' => [
'main' => [
'css' => [
realpath(__DIR__ . '/../resources/css/**/*.scss'),
],
'js' => [
realpath(__DIR__ . '/../resources/js/**/*.js'),
],
],
],
],
];
```

A gulpfile can now be created using the brokkr command `gulpfile`:
```sh
vendor/bin/brokkr gulpfile
```

## Changing the template

To change the template for your gulpfile, just copy view/gulpfile.js.php somewhere, change it, and add the new path to your module/site's config:
```php
<?php
return [
'gulp' => [
'template' => realpath(__DIR__ . '/../view/gulpfile.js.php'),
],
];
```

## Get Involved

File issues at https://github.com/riddlestone/brokkr-gulpfile/issues

0 comments on commit c2a0b76

Please sign in to comment.