summaryrefslogtreecommitdiffstats
path: root/node_modules/cli-boxes/readme.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/cli-boxes/readme.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/cli-boxes/readme.md')
-rw-r--r--node_modules/cli-boxes/readme.md94
1 files changed, 94 insertions, 0 deletions
diff --git a/node_modules/cli-boxes/readme.md b/node_modules/cli-boxes/readme.md
new file mode 100644
index 0000000..b81816b
--- /dev/null
+++ b/node_modules/cli-boxes/readme.md
@@ -0,0 +1,94 @@
+# cli-boxes [![Build Status](https://travis-ci.org/sindresorhus/cli-boxes.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-boxes)
+
+> Boxes for use in the terminal
+
+The list of boxes is just a [JSON file](boxes.json) and can be used wherever.
+
+
+## Install
+
+```
+$ npm install --save cli-boxes
+```
+
+
+## Usage
+
+```js
+const cliBoxes = require('cli-boxes');
+
+console.log(cliBoxes.single);
+/*
+{
+ "topLeft": "┌",
+ "topRight": "┐",
+ "bottomRight": "┘",
+ "bottomLeft": "└",
+ "vertical": "│",
+ "horizontal": "─"
+}
+*/
+```
+
+
+## API
+
+### cliBoxes
+
+#### `single`
+
+```
+┌────┐
+│ │
+└────┘
+```
+
+#### `double`
+
+```
+╔════╗
+║ ║
+╚════╝
+```
+
+#### `round`
+
+```
+╭────╮
+│ │
+╰────╯
+```
+
+#### `single-double`
+
+```
+╓────╖
+║ ║
+╙────╜
+```
+
+#### `double-single`
+
+```
+╒════╕
+│ │
+╘════╛
+```
+
+#### `classic`
+
+```
++----+
+| |
++----+
+```
+
+
+## Related
+
+- [boxen](https://github.com/sindresorhus/boxen) - Create boxes in the terminal
+
+
+## License
+
+MIT © [Sindre Sorhus](http://sindresorhus.com)