UNPKG

2.63 kBMarkdownView Raw
1# allspark
2
3![Node](https://img.shields.io/node/v/allspark.svg?style=flat-square)
4[![NPM](https://img.shields.io/npm/v/allspark.svg?style=flat-square)](https://www.npmjs.com/package/allspark)
5[![Travis](https://img.shields.io/travis/ngduc/allspark/master.svg?style=flat-square)](https://travis-ci.org/ngduc/allspark)
6[![David](https://img.shields.io/david/ngduc/allspark.svg?style=flat-square)](https://david-dm.org/ngduc/allspark)
7[![Coverage Status](https://img.shields.io/coveralls/ngduc/allspark.svg?style=flat-square)](https://coveralls.io/github/ngduc/allspark)
8[![NPM](https://img.shields.io/npm/dt/allspark.svg?style=flat-square)](https://www.npmjs.com/package/allspark)
9
10> allspark is a modern webapp generator
11
12### Usage
13
14```js
15import allspark from 'allspark';
16
17```
18
19### Installation
20
21Install via [yarn](https://github.com/yarnpkg/yarn)
22
23 yarn add allspark (--dev)
24
25or npm
26
27 npm install allspark (--save-dev)
28
29
30### configuration
31
32You can pass in extra options as a configuration object (➕ required, ➖ optional, ✏️ default).
33
34```js
35import allspark from 'allspark';
36
37```
38
39➖ **property** ( type ) ` ✏️ default `
40<br/> 📝 description
41<br/> ❗️ warning
42<br/> ℹ️ info
43<br/> 💡 example
44
45### methods
46
47#### #name
48
49```js
50allspark
51
52```
53
54### Examples
55
56See [`example`](example/script.js) folder or the [runkit](https://runkit.com/ngduc/allspark) example.
57
58### Builds
59
60If you don't use a package manager, you can [access `allspark` via unpkg (CDN)](https://unpkg.com/allspark/), download the source, or point your package manager to the url.
61
62`allspark` is compiled as a collection of [CommonJS](http://webpack.github.io/docs/commonjs.html) modules & [ES2015 modules](http://www.2ality.com/2014/0
63 -9/es6-modules-final.html) for bundlers that support the `jsnext:main` or `module` field in package.json (Rollup, Webpack 2)
64
65The `allspark` package includes precompiled production and development [UMD](https://github.com/umdjs/umd) builds in the [`dist/umd` folder](https://unpkg.com/allspark/dist/umd/). They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a [`<script>` tag](https://unpkg.com/allspark) on your page. The UMD builds make `allspark` available as a `window.allspark` global variable.
66
67### License
68
69The code is available under the [MIT](LICENSE) license.
70
71### Contributing
72
73We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
74
75### Misc
76
77This module was created using [generator-module-boilerplate](https://github.com/duivvv/generator-module-boilerplate).