From bd789c0e630c9e11201c72607a6b68a30bdef3ea Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Thu, 27 Feb 2020 10:06:06 +0000 Subject: [PATCH] :bookmark: 2.4.0 [skip ci] MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # [v2.4.0](https://github.com/beaussan/nbx/compare/v2.3.1...v2.4.0) (2020-02-27) ## ✨ New Features - [`8116e3a`](https://github.com/beaussan/nbx/commit/8116e3a) add generated changelog to cli ## ⬆️ Upgraded dependencies - [`a7823e2`](https://github.com/beaussan/nbx/commit/a7823e2) Upgrade dependency gluegun to v4.2.0 --- CHANGELOG.md | 10 +++++++ README.md | 81 +++++++++++++++++++++++++++++++++++++--------------- package.json | 2 +- 3 files changed, 69 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 20549ce..9b3327b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +# [v2.4.0](https://github.com/beaussan/nbx/compare/v2.3.1...v2.4.0) (2020-02-27) + +## ✨ New Features + +- [`8116e3a`](https://github.com/beaussan/nbx/commit/8116e3a) add generated changelog to cli + +## ⬆️ Upgraded dependencies + +- [`a7823e2`](https://github.com/beaussan/nbx/commit/a7823e2) Upgrade dependency gluegun to v4.2.0 + # [v2.3.1](https://github.com/beaussan/nbx/compare/v2.3.0...v2.3.1) (2020-02-27) ## 👽 Update code due to external API changes diff --git a/README.md b/README.md index c5479a4..89f2fe5 100644 --- a/README.md +++ b/README.md @@ -16,56 +16,92 @@ My own personal cli - -- [nbx](#nbx) -- [Usage](#usage) -- [Commands](#commands) - +* [nbx](#nbx) +* [Usage](#usage) +* [Commands](#commands) + # Usage - ```sh-session $ npm install -g @beaussan/nbx $ nbx COMMAND running command... $ nbx (-v|--version|version) -@beaussan/nbx/2.0.4 linux-x64 node-v13.7.0 +@beaussan/nbx/2.3.1 linux-x64 node-v13.8.0 $ nbx --help [COMMAND] USAGE $ nbx COMMAND ... ``` - # Commands +* [`nbx add:dep DEP`](#nbx-adddep-dep) +* [`nbx add:prettier`](#nbx-addprettier) +* [`nbx add:tailwind`](#nbx-addtailwind) +* [`nbx help [COMMAND]`](#nbx-help-command) +* [`nbx wall TERMS`](#nbx-wall-terms) + +## `nbx add:dep DEP` + +proxy to yarn add, plus gitmoji commit + +``` +USAGE + $ nbx add:dep DEP + +ARGUMENTS + DEP The dependency to install -- [`nbx add:prettier`](#nbx-addprettier) -- [`nbx help [COMMAND]`](#nbx-help-command) -- [`nbx wall TERMS`](#nbx-wall-terms) +OPTIONS + -D, --dev install as a dev dependency + -h, --help show CLI help + -v, --verbose Verbose output + --[no-]spinner Enable spinner in cli output, true by default + +EXAMPLES + $ nbx add:dep -D eslint + $ nbx add:dep --dev eslint + $ nbx add:dep chalk +``` + +_See code: [src/commands/add/dep.ts](https://github.com/beaussan/nbx/blob/v2.3.1/src/commands/add/dep.ts)_ ## `nbx add:prettier` -describe the command here +add prettier to project and format it ``` USAGE $ nbx add:prettier OPTIONS - -h, --help show CLI help - -v, --verbose Verbose output + -h, --help show CLI help + -v, --verbose Verbose output + --[no-]spinner Enable spinner in cli output, true by default +``` + +_See code: [src/commands/add/prettier.ts](https://github.com/beaussan/nbx/blob/v2.3.1/src/commands/add/prettier.ts)_ + +## `nbx add:tailwind` + +add tailwindcss to a project -EXAMPLE - $ nbx wall - hello world from ./src/hello.ts! ``` +USAGE + $ nbx add:tailwind -_See code: [src/commands/add/prettier.ts](https://github.com/beaussan/nbx/blob/v2.0.4/src/commands/add/prettier.ts)_ +OPTIONS + -h, --help show CLI help + -v, --verbose Verbose output + --[no-]spinner Enable spinner in cli output, true by default +``` + +_See code: [src/commands/add/tailwind.ts](https://github.com/beaussan/nbx/blob/v2.3.1/src/commands/add/tailwind.ts)_ ## `nbx help [COMMAND]` @@ -86,7 +122,7 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3 ## `nbx wall TERMS` -describe the command here +download a wallpaper from wallhaven using search ``` USAGE @@ -105,14 +141,13 @@ OPTIONS -r, --random Pick one randomly -s, --sketchy Enables sketchy search -v, --verbose Verbose output + --[no-]spinner Enable spinner in cli output, true by default EXAMPLE - $ nbx wall - hello world from ./src/hello.ts! + $ nbx wall -r "cat" -o "wall.jpg" -fg ``` -_See code: [src/commands/wall/index.ts](https://github.com/beaussan/nbx/blob/v2.0.4/src/commands/wall/index.ts)_ - +_See code: [src/commands/wall/index.ts](https://github.com/beaussan/nbx/blob/v2.3.1/src/commands/wall/index.ts)_ ## Contributors ✨ diff --git a/package.json b/package.json index 13b480b..ab31b34 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@beaussan/nbx", "description": "My own personal cli", - "version": "2.3.1", + "version": "2.4.0", "author": "Nicolas Beaussart @beaussan", "bin": { "nbx": "./bin/run"