docs

README.md

@@ -0,0 +1,42 @@
+ansi-html [![NPM version](https://badge.fury.io/js/ansi-html.svg)](http://badge.fury.io/js/ansi-html) [![Build Status](https://travis-ci.org/Tjatse/ansi-html.svg?branch=master)](https://travis-ci.org/Tjatse/ansi-html)
+=========
+An elegant lib that converts the chalked (ANSI) text to HTML.
+
+# Coverage
+All styles of [chalk](https://github.com/sindresorhus/chalk).
+There are over **150** randomized test cases under `test`.
+
+# Installation
+```
+$ npm install ansi-html
+```
+
+# Usage
+```
+var ansiHTML = require('ansi-html);
+var str = ansiHTML([ANSI_TEXT]);
+```
+
+e.g.:
+```javascript
+var ansiHTML   = require('../'),
+    chalk = require('chalk');
+
+var str = chalk.bold.red('foo') + ' bar';
+console.log('[ANSI]', str)
+console.log('[HTML]', ansiHTML(str));
+```
+
+See complete examples under `test` / `examples` directory.
+
+# Exposed Tags
+```
+var openTags = ansiHTML.tags.open;
+var openTags = ansiHTML.tags.close;
+```
+
+# Test
+```
+$ npm install -l
+$ npm test
+```