From 81899b464cefd0592ff6e6ce9e12f7d4f674915a Mon Sep 17 00:00:00 2001 From: ybiquitous Date: Thu, 31 Aug 2017 10:41:50 +0900 Subject: [PATCH] feat: rename project to `ybiq` (#3) --- README.md | 18 +++++++++++++++--- bin/cli.test.js | 4 ++-- package-lock.json | 2 +- package.json | 12 ++++++------ src/cli.js | 4 ++-- 5 files changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index db4bf81c..25ee12de 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,29 @@ -# ybiquitous's command-line tools +# ybiq [![Build Status](https://travis-ci.org/ybiquitous/cli.svg?branch=master)](https://travis-ci.org/ybiquitous/cli) +Command-line utilities for `npm`. + ## Install ```sh -npm install @ybiquitous/cli --save-dev +npm install ybiq --save-dev ``` ## Usage +For details, please show help. + +```sh +ybiq --help +``` + +### `init` + +Setup npm project. + ```sh -ybiquitous --help +ybiq init ``` ## License diff --git a/bin/cli.test.js b/bin/cli.test.js index 028aadd4..969b0e6c 100644 --- a/bin/cli.test.js +++ b/bin/cli.test.js @@ -5,10 +5,10 @@ import assert from 'assert' import assertThrows from '../test/assert-throws' const HELP = ` -ybiquitous +ybiq Commands: - init Initialize Node.js project + init Setup npm project Options: --help Show help [boolean] diff --git a/package-lock.json b/package-lock.json index 7162df66..7f420e1f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "@ybiquitous/cli", + "name": "ybiq", "version": "0.1.0", "lockfileVersion": 1, "requires": true, diff --git a/package.json b/package.json index dedac1f5..fcb613cf 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { - "name": "@ybiquitous/cli", + "name": "ybiq", "version": "0.1.0", - "description": "ybiquitous's command-line tools", + "description": "Command-line utilities for npm", "author": "ybiquitous ", "license": "MIT", - "repository": "ybiquitous/cli", - "bugs": "https://github.com/ybiquitous/cli/issues", - "homepage": "https://github.com/ybiquitous/cli#readme", + "repository": "ybiquitous/ybiq", + "bugs": "https://github.com/ybiquitous/ybiq/issues", + "homepage": "https://github.com/ybiquitous/ybiq#readme", "keywords": [ "cli", "command-line", @@ -15,7 +15,7 @@ ], "main": "index.js", "bin": { - "ybiquitous": "./bin/cli.js" + "ybiq": "./bin/cli.js" }, "dependencies": { "@commitlint/cli": "^3.1.3", diff --git a/src/cli.js b/src/cli.js index 25ed67d2..d3ed40e9 100644 --- a/src/cli.js +++ b/src/cli.js @@ -4,10 +4,10 @@ const init = require('./init') module.exports = function cli() { // eslint-disable-next-line no-unused-expressions yargs - .usage('ybiquitous ') + .usage('ybiq ') .command({ command: 'init', - desc: 'Initialize Node.js project', + desc: 'Setup npm project', handler: () => init(), }) .demandCommand(1)