readline-ui - npm Package Compare versions

Comparing version 0.1.3 to 0.1.4

index.js

@@ -170,2 +170,10 @@ 'use strict';
 /**
+ * Proxy to `.write` on the readline instance
+ */
+
+UI.prototype.write = function() {
+  this.rl.write.apply(this.rl, arguments);
+};
+
+/**
  * Pause the input stream, allowing it to be resumed later if necessary.
@@ -172,0 +180,0 @@ */

package.json

 {
   "name": "readline-ui",
   "description": "Create readline interface to use in prompts.",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "homepage": "https://github.com/enquirer/readline-ui",
@@ -24,4 +24,4 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
     "component-emitter": "^1.2.1",
-    "debug": "^2.6.3",
-    "readline-utils": "^0.1.4",
+    "debug": "^2.6.6",
+    "readline-utils": "^0.1.6",
     "string-width": "^2.0.0",
@@ -32,3 +32,3 @@ "strip-color": "^0.1.0"
     "gulp-format-md": "^0.1.12",
-    "mocha": "^3.2.0"
+    "mocha": "^3.3.0"
   },
@@ -80,8 +80,4 @@ "keywords": [
       ]
-    },
-    "reflinks": [
-      "verb",
-      "verb-generate-readme"
-    ]
+    }
   }
 }

README.md

@@ -1,2 +0,2 @@
-# readline-ui [![NPM version](https://img.shields.io/npm/v/readline-ui.svg?style=flat)](https://www.npmjs.com/package/readline-ui) [![NPM downloads](https://img.shields.io/npm/dm/readline-ui.svg?style=flat)](https://npmjs.org/package/readline-ui) [![Build Status](https://img.shields.io/travis/enquirer/readline-ui.svg?style=flat)](https://travis-ci.org/enquirer/readline-ui)
+# readline-ui [![NPM version](https://img.shields.io/npm/v/readline-ui.svg?style=flat)](https://www.npmjs.com/package/readline-ui) [![NPM monthly downloads](https://img.shields.io/npm/dm/readline-ui.svg?style=flat)](https://npmjs.org/package/readline-ui) [![NPM total downloads](https://img.shields.io/npm/dt/readline-ui.svg?style=flat)](https://npmjs.org/package/readline-ui) [![Linux Build Status](https://img.shields.io/travis/enquirer/readline-ui.svg?style=flat&label=Travis)](https://travis-ci.org/enquirer/readline-ui)
 
@@ -20,2 +20,22 @@ > Create readline interface to use in prompts.
 
+## API
+
+### [.render](index.js#L75)
+
+Render the given `str` in the terminal, and optional `bottomContent`.
+
+**Params**
+
+* `str` **{String}**
+* `bottomContent` **{String}**
+* `returns` **{undefined}**
+
+### [.clearLines](index.js#L144)
+
+Remove `n` lines from the bottom of the terminal
+
+**Params**
+
+* `lines` **{Number}**: Number of lines to remove
+
 ## Attribution
@@ -38,12 +58,12 @@
 
-Please read the [contributing guide](.github/contributing.md) for avice on opening issues, pull requests, and coding standards.
+Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
 
 ### Building docs
 
-_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
+_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
 
-To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
+To generate the readme, run the following command:
 
 ```sh
-$ npm install -g verb verb-generate-readme && verb
+$ npm install -g verbose/verb#dev verb-generate-readme && verb
 ```
@@ -53,6 +73,6 @@
 
-Install dev dependencies:
+Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
 
 ```sh
-$ npm install -d && npm test
+$ npm install && npm test
 ```
@@ -65,11 +85,11 @@
 * [github/jonschlinkert](https://github.com/jonschlinkert)
-* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
 
 ### License
 
-Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
-Released under the [MIT license](https://github.com/enquirer/readline-ui/blob/master/LICENSE).
+Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.31, on September 21, 2016._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 05, 2017._

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12093

increased by5.02%

Lines of code

196

increased by3.16%

Number of lines in readme file

91

increased by28.17%

Dependency changes

• Updateddebug@^2.6.6

• Updatedreadline-utils@^0.1.6