# slush-joomla [![npm version](https://img.shields.io/npm/v/slush-joomla.svg)](https://www.npmjs.com/package/slush-joomla) [![depstatus](https://img.shields.io/david/welksonramos/slush-joomla.svg)](https://david-dm.org/welksonramos/slush-joomla) [![license](https://img.shields.io/npm/l/slush-joomla.svg?style=flat)](https://raw.github.com/welksonramos/slush-joomla/blob/master/LICENSE)

> A simple slush generator for Joomla templates

![demo](demo.gif)

## Getting Started

Install `slush-joomla` globally:

```bash
$ npm install -g slush-joomla
```

Remember to install `slush` globally as well, if you haven't already:

```bash
$ npm install -g slush
```

### Usage

create a new directory inside the templates directory of your joomla installation:

In _**path/to/joomla/templates/**_

```bash
$ mkdir myproject && cd myproject
```

Run the generator from within the new folder:

```bash
$ slush joomla
```

## License

Lincensed under The MIT License (MIT)