vbuild/template/README.md

Refined webpack development experience for Vue.js

# <%= name %>

<%_ if (component) { -%>
## Install

```bash
yarn add <%= name %>
```

## Usage

```js
import <%= moduleName %> from '<%= name %>'

//... your code
```
<%_ } -%>

## Folder structure

<%_ if (component) { -%>
- `src/`: Source files for this component
  - `<%= moduleName %>.vue` The component itself
- `example/`: Example for demonstrating this component
  - `index.js`: Entry for the example
  - `App.vue`: The root component which we use to load this component
<%_ } else { -%>
- `src/`: App files
  - `components/`: Components directory
  - `index.js`: App entry file
<%_ } -%>
<%_ if (electron) { -%>
- `app/`: Electron app files for main process
  - `index.js`: Electron app main process entry
<%_ } -%>
<%_ if (component) { -%>
- `vbuild.example.js`: Config file for your example
- `vbuild.component.js`: Config file for your component
<%_ } else { -%>
- `vbuild.config.js`: Config file for vbuild
<%_ } -%>
- `package.json`: App manifest
- `.editorconfig`: Ensure consistent editor behaivor
- `.gitignore`: Ignore files we don't need to push

## Development

<%_ if (component) { -%>
- `yarn example`: Run example in development mode
- `yarn deploy`: Deploy example to gh-pages
- `yarn build:cjs`: Build component in commonjs format
- `yarn build:umd`: Build component in umd format
- `yarn build`: Build component in both format
<%_ } else { -%>
- `yarn dev`: Run in development mode
- `yarn build`: Build in production mode
<%_ } -%>
- `yarn lint`: Run eslint
<%_ if (electron) { -%>
- `yarn dist`: Distribute Electron app for mac/windows/linux
- `yarn dist:mac`: Distribute Electron app for mac
- `yarn dist:win`: Distribute Electron app for windows
- `yarn dist:linux`: Distribute Electron app for linux
<%_ } -%>

---

Generated by [vbuild](https://github.com/egoist/vbuild)