aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 269012571c95314d34584c0fcfee95d8736e075f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Create riot component

Create a component skeleton for [riot.js](http://riotjs.com/). Designed to be used with ES6 import syntax and SASS.

## Installation

### With yarn
`yarn global add create-riot-component`

### With npm
`npm install -g create-riot-component`

## Usage

`create-riot-component [component-name]`

This command would create the following directory structure:

```
component-name
  - component-name.tag
  - component-name.scss
  - index.js  // for importing the directory
```

## Author

Jan Tuomi 2017