Skip to content

Commit e868818

Browse files
committed
docs(readme): update documentation
1 parent 60bd7e1 commit e868818

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
# Frontvue-Plugin-Pug
1+
# Frontvue-Plugin-JS
22

3-
[![Build Status](https://travis-ci.org/0vidiu/frontvue-plugin-pug.svg?branch=master)](https://travis-ci.org/0vidiu/frontvue-plugin-pug) [![codecov](https://codecov.io/gh/0vidiu/frontvue-plugin-pug/branch/master/graph/badge.svg)](https://codecov.io/gh/0vidiu/frontvue-plugin-pug) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
3+
[![Build Status](https://travis-ci.org/0vidiu/frontvue-plugin-js.svg?branch=master)](https://travis-ci.org/0vidiu/frontvue-plugin-js) [![codecov](https://codecov.io/gh/0vidiu/frontvue-plugin-js/branch/master/graph/badge.svg)](https://codecov.io/gh/0vidiu/frontvue-plugin-js) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
44

5-
## A Frontvue plugin for Pug boilerplate and processing
6-
This plugin will be one of the available options to choose from when you configure a new project using Frontvue. It handles Pug files and comes with a boilerplate template of Pug partials. It comes with the following tasks:
7-
* *pug:config* — registers a configuration questionnaire;
8-
* *pug:template* — copies the Pug template;
9-
* *pug:clean* — removes the build folder;
10-
* *pug:process* — handles compiling of Pug partials;
11-
* *pug:watch* — starts listeners for changes in Pug partials;
5+
## A Frontvue plugin for JavaScript boilerplate and processing
6+
This plugin will be one of the available options to choose from when you configure a new project using Frontvue. It handles JavaScript ES6 files and comes with a boilerplate template (w.i.p). It comes with the following tasks:
7+
* *js:config* — registers a configuration questionnaire;
8+
* *js:template* — copies the JavaScript ES6 template;
9+
* *js:clean* — removes the build folder;
10+
* *js:process* — handles compiling of JS partials;
11+
* *js:watch* — starts listeners for changes in JS partials;
1212

1313
## Default configuration
1414
```js
1515
{
1616
// Source files directory name
17-
sourceDir: 'pug',
17+
sourceDir: 'js',
1818

19-
// Directory name where the HTML file(s) will be outputted
20-
buildDir: 'html'
19+
// Directory name where the JS file(s) will be outputted
20+
buildDir: 'js',
21+
22+
// Entry point(s)
23+
entrypoints: 'index.js',
2124
}
2225
```

src/config/config-questionnaire.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export default {
2525
},
2626
{
2727
default: defaults.entrypoints,
28-
message: `Enter entrypoint filename(s).\n Multiple files need to be separated by commas: 'index.js,server.js'`,
28+
message: `Enter entrypoint filename(s).\n Multiple files need to be separated by commas: 'index.js,modules.js'`,
2929
name: 'entrypoints',
3030
type: 'input',
3131
},

0 commit comments

Comments
 (0)