1 | # ybiq
|
2 |
|
3 | [![npm](https://img.shields.io/npm/v/ybiq.svg)](https://www.npmjs.com/package/ybiq)
|
4 | [![node](https://img.shields.io/node/v/ybiq.svg)](https://github.com/ybiquitous/ybiq)
|
5 | [![Build Status](https://travis-ci.org/ybiquitous/ybiq.svg?branch=master)](https://travis-ci.org/ybiquitous/ybiq)
|
6 | [![MIT License](https://img.shields.io/github/license/ybiquitous/ybiq.svg)](LICENSE)
|
7 | [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
|
8 | [![Changelog](https://img.shields.io/badge/changelog-here-blue.svg)](CHANGELOG.md)
|
9 |
|
10 | Useful command-line tools for Node.js project.
|
11 |
|
12 | ## Table of Contents
|
13 |
|
14 | 1. [Install](#install)
|
15 | 2. [Usage](#usage)
|
16 | 1. [CLI](#cli)
|
17 | 2. [API](#api)
|
18 |
|
19 | ## Install
|
20 |
|
21 | ```sh
|
22 | npm install --save-dev ybiq
|
23 | ```
|
24 |
|
25 | In addition, if you want to use [`eslint-config-ybiquitous`](https://npm.im/eslint-config-ybiquitous),
|
26 | please run another install command.
|
27 |
|
28 | ```sh
|
29 | npm install --save-dev eslint-config-ybiquitous
|
30 | ```
|
31 |
|
32 | ## Usage
|
33 |
|
34 | ### CLI
|
35 |
|
36 | For details, please show help.
|
37 |
|
38 | ```sh
|
39 | ybiq --help
|
40 | ```
|
41 |
|
42 | ### `init`
|
43 |
|
44 | Setup npm project.
|
45 |
|
46 | ```sh
|
47 | ybiq init
|
48 | ```
|
49 |
|
50 | ### API
|
51 |
|
52 | ```js
|
53 | const ybiq = require("ybiq");
|
54 |
|
55 | ybiq.init({
|
56 | // Default options
|
57 | // cwd: process.cwd(),
|
58 | // logger: msg => process.stdout.write(msg),
|
59 | });
|
60 | ```
|