summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/update-notifier/node_modules/boxen/readme.md
diff options
context:
space:
mode:
authorRebecca Turner <me@re-becca.org>2017-04-12 21:47:49 -0700
committerJeremiah Senkpiel <fishrock123@rocketmail.com>2017-04-25 10:52:01 -0400
commit00842604483e4c2e622dfdb3a97440e07646158f (patch)
treef3346902636a44b6037652523767636bf7e4f2c9 /deps/npm/node_modules/update-notifier/node_modules/boxen/readme.md
parent061c5da010e0d249379618382a499840d38247b8 (diff)
downloadandroid-node-v8-00842604483e4c2e622dfdb3a97440e07646158f.tar.gz
android-node-v8-00842604483e4c2e622dfdb3a97440e07646158f.tar.bz2
android-node-v8-00842604483e4c2e622dfdb3a97440e07646158f.zip
deps: upgrade npm to 4.5.0
PR-URL: https://github.com/nodejs/node/pull/12480 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Diffstat (limited to 'deps/npm/node_modules/update-notifier/node_modules/boxen/readme.md')
-rw-r--r--deps/npm/node_modules/update-notifier/node_modules/boxen/readme.md175
1 files changed, 175 insertions, 0 deletions
diff --git a/deps/npm/node_modules/update-notifier/node_modules/boxen/readme.md b/deps/npm/node_modules/update-notifier/node_modules/boxen/readme.md
new file mode 100644
index 0000000000..abb78bff12
--- /dev/null
+++ b/deps/npm/node_modules/update-notifier/node_modules/boxen/readme.md
@@ -0,0 +1,175 @@
+# <img src="screenshot.png" width="400" alt="boxen">
+
+> Create boxes in the terminal
+
+[![Build Status](https://travis-ci.org/sindresorhus/boxen.svg?branch=master)](https://travis-ci.org/sindresorhus/boxen)
+
+
+## Install
+
+```
+$ npm install --save boxen
+```
+
+
+## Usage
+
+```js
+const boxen = require('boxen');
+
+console.log(boxen('unicorn', {padding: 1}));
+/*
+┌─────────────┐
+│ │
+│ unicorn │
+│ │
+└─────────────┘
+*/
+
+console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));
+/*
+
+ ╔═════════════╗
+ ║ ║
+ ║ unicorn ║
+ ║ ║
+ ╚═════════════╝
+
+*/
+```
+
+
+## API
+
+### boxen(input, [options])
+
+#### input
+
+Type: `string`
+
+Text inside the box.
+
+#### options
+
+##### borderColor
+
+Type: `string`<br>
+Values: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white` `gray`
+
+Color of the box border.
+
+##### borderStyle
+
+Type: `string` `object`<br>
+Default: `single`<br>
+Values:
+- `single`
+```
+┌───┐
+│foo│
+└───┘
+```
+- `double`
+```
+╔═══╗
+║foo║
+╚═══╝
+```
+- `round` (`single` sides with round corners)
+```
+╭───╮
+│foo│
+╰───╯
+```
+- `single-double` (`single` on top and bottom, `double` on right and left)
+```
+╓───╖
+║foo║
+╙───╜
+```
+- `double-single` (`double` on top and bottom, `single` on right and left)
+```
+╒═══╕
+│foo│
+╘═══╛
+```
+- `classic`
+```
++---+
+|foo|
++---+
+```
+
+Style of the box border.
+
+Can be any of the above predefined styles or an object with the following keys:
+
+```js
+{
+ topLeft: '+',
+ topRight: '+',
+ bottomLeft: '+',
+ bottomRight: '+',
+ horizontal: '-',
+ vertical: '|'
+}
+```
+
+##### dimBorder
+
+Type: `boolean`<br>
+Default: `false`
+
+Reduce opacity of the border.
+
+##### padding
+
+Type: `number` `object`<br>
+Default: `0`
+
+Space between the text and box border.
+
+Accepts a number or an object with any of the `top`, `right`, `bottom`, `left` properties. When a number is specified, the left/right padding is 3 times the top/bottom to make it look nice.
+
+##### margin
+
+Type: `number` `object`<br>
+Default: `0`
+
+Space around the box.
+
+Accepts a number or an object with any of the `top`, `right`, `bottom`, `left` properties. When a number is specified, the left/right margin is 3 times the top/bottom to make it look nice.
+
+##### float
+
+Type: `string`<br>
+Values: `right` `center` `left`<br>
+Default: `left`
+
+Float the box on the available terminal screen space.
+
+##### backgroundColor
+
+Type: `string`<br>
+Values: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white`
+
+Color of the background.
+
+##### align
+
+Type: `string`<br>
+Default: `left`<br>
+Values: `left` `center` `right`
+
+Align the text in the box based on the widest line.
+
+
+## Related
+
+- [boxen-cli](https://github.com/sindresorhus/boxen-cli) - CLI for this module
+- [cli-boxes](https://github.com/sindresorhus/cli-boxes) - Boxes for use in the terminal
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)