base-yarn
v1.0.0
Published
Plugin for adding yarn methods to your Base application.
Downloads
4
Maintainers
Readme
base-yarn
Plugin for adding yarn methods to your Base application.
Install
Install with npm:
$ npm install --save base-yarn
Install with yarn:
$ yarn add base-yarn
Usage
var Base = require('base');
var base = new Base({isApp: true});
var yarn = require('..');
base.use(yarn());
Examples
See the examples directory for code examples that can be run.
base.yarn.add(['isobject', 'micromatch'], function(err) {
if (err) throw err;
console.log('done');
});
// custom arguments
base.yarn(['why', 'find-pkg'], function(err) {
if (err) throw err;
console.log('done');
});
API
This plugin exposes the full API from the yarn-api library. See that project for all available methods and documentation.
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on April 27, 2017.