Simplified API and updated README

Author: gregnr

README.md

@@ -1,70 +1,82 @@
-# Character Printer
+<img alt="Ninja Print title" src="https://secure.servalldatasystems.com/servall_dev_files/ninja-print/ninja-print.png" height="180px" width="536.5px">
 
-Character Printer is a utility for printing human-readable special characters.
+### *Finding those ninja characters*
 
-Are you ever working with low-level binary or string data that contains special characters (NUL, CR, LF, etc)? Unfortunately `console.log()` has no way to display special characters, making it difficult to determine exactly where they exist in a `String` or `Buffer`. Character Printer makes your life easy by printing out a human readable form of each character.
+<img alt="Ninja Print demo" src="https://secure.servalldatasystems.com/servall_dev_files/ninja-print/ninja-print.gif" height="225px" width="400px">
+
+# What is it?
+
+Ninja Print is a utility for printing human-readable special characters.
+
+Are you ever working with binary or string data that contains special characters (NUL, CR, LF, etc)? Unfortunately standard print commands (`echo`, `printf`, `console.log`, etc) will not display special characters, making it difficult to determine exactly where they exist in a `string`. Ninja Print makes your life easy by printing out a human-readable form of each character.
+
+# Installation
+
+`ninprint` requires [NodeJS](https://nodejs.org) and [NPM](https://www.npmjs.com)/[Yarn](https://yarnpkg.com).
 
-## Installation
 #### NPM
 ```bash
-npm install character-printer
+npm install -g ninprint
 ```
 #### Yarn
 
 ```bash
-yarn add character-printer
+yarn global add ninprint
 ```
 
-## Examples
-```javascript
-const { printCharacters } = require("character-printer");
+# Examples
 
-printCharacters("Hello world.");
-// Output:
-//     H e l l o [SPACE] w o r l d .
-
-printCharacters("Line feed:\n");
-// Output:
-//     L i n e [SPACE] f e e d : [LF]
+You can pipe output from other processes into `ninprint`:
+```bash
+$ printf "From pipe: \0\r\n" | ninprint
 
-printCharacters("Carriage return:\r");
-// Output:
-//     C a r r i a g e [SPACE] r e t u r n : [CR]
+F r o m [SPACE] p i p e : [SPACE] [NUL] [CR] [LF]
+```
 
-printCharacters("Null character:\0");
-// Output:
-//     N u l l [SPACE] c h a r a c t e r : [NUL]
+Anything sent to `stdin` will be processed:
+```bash
+$ printf "From file: \b\f\t" > test.bin
+$ ninprint < test.bin
 
-printCharacters(new Buffer([0x00, 0x01, 0x02, 0x03, 0x04, 0x05]));
-// Output:
-//     [NUL] [SOH] [STX] [ETX] [EOT] [ENQ]
+F r o m [SPACE] f i l e : [SPACE] [BS] [FF] [TAB]
 ```
 
-## Command Line Interface (CLI)
-You can also use the command line interface to print characters from other processes or files using pipe.
+# Node Module
+You can also use `ninprint` as a Node/Webpack module.
 
 #### NPM
 ```bash
-npm install -g character-printer
+npm install ninprint
 ```
 #### Yarn
 
 ```bash
-yarn global add character-printer
+yarn add ninprint
 ```
 
-Examples:
+## Examples
+```javascript
+const { print: ninprint } = require("ninprint");
 
-```bash
-$ printf "From pipe: \0\r\n" | character-printer
+ninprint("Hello world.");
+// Output:
+//     H e l l o [SPACE] w o r l d .
 
-F r o m [SPACE] p i p e : [SPACE] [NUL] [CR] [LF]
-```
-```bash
-$ printf "From file: \b\f\t" > test.bin
-$ character-printer < test.bin
+ninprint("Line feed:\n");
+// Output:
+//     L i n e [SPACE] f e e d : [LF]
 
-F r o m [SPACE] f i l e : [SPACE] [BS] [FF] [TAB]
+ninprint("Carriage return:\r");
+// Output:
+//     C a r r i a g e [SPACE] r e t u r n : [CR]
+
+ninprint("Null character:\0");
+// Output:
+//     N u l l [SPACE] c h a r a c t e r : [NUL]
+
+ninprint(new Buffer([0x00, 0x01, 0x02, 0x03, 0x04, 0x05]));
+// Output:
+//     [NUL] [SOH] [STX] [ETX] [EOT] [ENQ]
 ```
 
 # License