aboutsummaryrefslogtreecommitdiff
path: root/node_modules/ava-init/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-28 00:38:50 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-28 00:40:43 +0200
commit7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027 (patch)
tree6de9a1aebd150a23b7f8c273ec657a5d0a18fe3e /node_modules/ava-init/readme.md
parent963b7a41feb29cc4be090a2446bdfe0c1f1bcd81 (diff)
downloadwallet-core-7fff4499fd915bcea3fa93b1aa8b35f4fe7a6027.tar.xz
add linting (and some initial fixes)
Diffstat (limited to 'node_modules/ava-init/readme.md')
-rw-r--r--node_modules/ava-init/readme.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/node_modules/ava-init/readme.md b/node_modules/ava-init/readme.md
new file mode 100644
index 000000000..596d098cb
--- /dev/null
+++ b/node_modules/ava-init/readme.md
@@ -0,0 +1,63 @@
+# ava-init [![Build Status: Linux](https://travis-ci.org/avajs/ava-init.svg?branch=master)](https://travis-ci.org/avajs/ava-init) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/abj17qsw0j1rts7l/branch/master?svg=true)](https://ci.appveyor.com/project/ava/ava-init/branch/master)
+
+> Add [AVA](https://ava.li) to your project
+
+
+## Install
+
+```
+$ npm install --save ava-init
+```
+
+
+## Usage
+
+```js
+const avaInit = require('ava-init');
+
+avaInit().then(() => {
+ console.log('done');
+});
+```
+
+
+## API
+
+### avaInit([options])
+
+Returns a `Promise`.
+
+#### options
+
+#### cwd
+
+Type: `string`<br>
+Default: `'.'`
+
+Current working directory.
+
+#### args
+
+Type: `Array`<br>
+Default: CLI arguments *(`process.argv.slice(2)`)*
+
+For instance, with the arguments `['--foo', '--bar']`, the following will be put in package.json:
+
+```json
+{
+ "name": "awesome-package",
+ "scripts": {
+ "test": "ava --foo --bar"
+ }
+}
+```
+
+
+## CLI
+
+Install AVA globally `$ npm install --global ava` and run `$ ava --init [<options>]`.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)