Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mjeanroy committed Aug 1, 2019
1 parent dadf592 commit 3783b8b
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,47 @@ license({
})
```

## Comment style

Since version 0.10.0, it is possible to customize banner style using the `commentStyle` option:

```javascript
license({
banner: {
file: path.join(__dirname, 'LICENSE'),
commentStyle: 'regular', // The default
},
})
```

Following options are available:

- `regular`: "classic" comment block is used (this is the default), for example:

```javascript
/**
* This is the `regular` style.
*/
```

- `ignored`: a comment block with prefix ignored by minifiers, for example:

```javascript
/*!
* This is the `ignored` style.
*/
```

- `slash`: banner is prepended using "slash" comments, for example:

```javascript
//
// This is the `slash` style.
//
```

- `none`: nothing done, be careful to prepenbd a banner already "commented".

## Changelogs

- 0.8.1
Expand Down

0 comments on commit 3783b8b

Please sign in to comment.