update readme

Author: jianglibo

README.md

@@ -1,12 +1,20 @@
 # Ascii Tree
 
-convert indented line block to an ascii directory tree.
+convert indented line block to an ascii directory tree.[中文](README_ZH.md)
 
-## usage
+## sync
 
 convert one tree.
 ```javascript
-var convertedLines = new AsciiTree(lines, "-").convert(); // "-" is optional, AsciiTree will guess the leading char.
+  var tree = new AsciiTree(BytesLine.getArray("hello")).convert();
+  assert.equal("└── hello", tree.toString());
+  // or use builder helper.
+  var tree = new AsciiTreeBuilder().withString("hello").withEncode("UTF-8").build().convert();
+  assert.equal("└── hello", tree.toString());
+
+  tree.toBufferArray();
+  tree.toStringArray();
+  tree.toString();
 ```
 
 convert mutilple blocks in a file. block is surround by startTag and endTag, which can be a string or a regex. prepend will be the first line of block result, append will be last line or result.
@@ -23,9 +31,20 @@ package.json
 ```
 
 ```javascript
-var convertedLines = new AsciiTrees(lines, startTag, endTag,prepend, append, "-").convert();
+  var convertor = new Convertor(string, /^{%\s+asciitree\s+%}$/, "{% endasciitree %}", '<pre>', '</pre>').convert();
+  //or use builder helper.
+
+  var convertorBuilder = new ConvertorBuilder()
+    .withContent(string)
+    .withStartTag("{% asciitree %}")
+    .withEndTag("{% endasciitree %}")
+    .withPrepend("<pre>")
+    .withAppend("</pre>");
 
-var convertedLines = new AsciiTrees(lines,/^{%\s+asciitree\s+%}$/, "{% endasciitree %}", '<pre>', '</pre>');
+  var convertor = convertorBuilder.build().convert();
+  convertor.toStringArray();
+  convertor.toBufferArray();
+  convertor.toString();
 ```
 results:
 
@@ -60,3 +79,25 @@ out:
 |       └── Brocfile.js
 └── package.json
 ```
+
+## stream
+
+```javascript
+  var src = fs.createReadStream('fixtures/tagfile.txt');
+  var dst = fs.createWriteStream('file.txt');
+  src.pipe(splitterStream()) //to BytesLine
+    .pipe(blockStream("{% asciitree %}", "{% endasciitree %}")) //produce one line or block of lines.
+    .pipe(treeStream()) // bypass oneline, process block of lines.
+    .pipe(unwrapStream()) // flatten block lines to Buffer.
+    .pipe(dst);
+
+  //or define a function
+  function treepipe(src) {
+   return src.pipe(splitterStream()) //to BytesLine
+    .pipe(blockStream("{% asciitree %}", "{% endasciitree %}")) //produce one line or block of lines.
+    .pipe(treeStream()) // bypass oneline, process block of lines.
+    .pipe(unwrapStream()); // flatten block lines to Buffer.
+  }
+
+  treepipe(src).pipe(dst);
+```

README_ZH.md

@@ -0,0 +1,103 @@
+# Ascii Tree
+
+将锯齿状的行块转换成一个Ascii树。 [English](README.md)
+
+## 同步版本
+
+转换一棵树，不包含树的分隔行。换行符在转换过程中保持不变。
+```javascript
+  var tree = new AsciiTree(BytesLine.getArray("hello")).convert();
+  assert.equal("└── hello", tree.toString());
+  // or use builder helper.
+  var tree = new AsciiTreeBuilder().withString("hello").withEncode("UTF-8").build().convert();
+  assert.equal("└── hello", tree.toString());
+
+  tree.toBufferArray();
+  tree.toStringArray();
+  tree.toString();
+```
+将文本中的所有树作转换，树行块通过分割行定义开始和结束。比如下面的文本块。
+
+```
+{% asciitree %}
+app
+-main.js
+-helper.js
+-others
+--Brocfile.js
+package.json
+{% endasciitree %}
+```
+
+```javascript
+  //识别分割行的可以是字符串或正则表达式，字符的话是trim首尾之后的相等。
+  var convertor = new Convertor(string, /^{%\s+asciitree\s+%}$/, "{% endasciitree %}", '<pre>', '</pre>').convert();
+
+  //or use builder helper.
+  var convertorBuilder = new ConvertorBuilder()
+    .withContent(string)
+    .withStartTag("{% asciitree %}")
+    .withEndTag("{% endasciitree %}")
+    .withPrepend("<pre>")
+    .withAppend("</pre>");
+
+  var convertor = convertorBuilder.build().convert();
+  convertor.toStringArray();
+  convertor.toBufferArray();
+  convertor.toString();
+```
+results:
+
+```
+<pre>
+├── app
+|   ├── main.js
+|   ├── helper.js
+|   └── others
+|       └── Brocfile.js
+└── package.json
+</pre>
+```
+
+
+in:
+```
+app
+-main.js
+-helper.js
+-others
+--Brocfile.js
+package.json
+```
+
+out:
+```
+├── app
+|   ├── main.js
+|   ├── helper.js
+|   └── others
+|       └── Brocfile.js
+└── package.json
+```
+
+## 流版本
+
+```javascript
+  var src = fs.createReadStream('fixtures/tagfile.txt');
+  var dst = fs.createWriteStream('file.txt');
+  src.pipe(splitterStream()) //将输入流变成BytesLine输出流
+    .pipe(blockStream("{% asciitree %}", "{% endasciitree %}")) //产生单一的行（不在树中间的话），行块（对应一棵树）
+    .pipe(treeStream()) // 将单一行直接传递下去，将树块转换之后传递
+    .pipe(unwrapStream()) // 扁平化成Buffer
+    .pipe(dst);
+    
+  //or define a function
+  function treepipe(src) {
+   return src.pipe(splitterStream()) //to BytesLine
+    .pipe(blockStream("{% asciitree %}", "{% endasciitree %}")) //produce one line or block of lines.
+    .pipe(treeStream()) // bypass oneline, process block of lines.
+    .pipe(unwrapStream()); // flatten block lines to Buffer.
+  }
+
+  treepipe(src).pipe(dst);
+```

index.js

@@ -1,11 +1,11 @@
 var TreeLine = require('./lib/tree-line');
 var AsciiTree = require('./lib/ascii-tree');
-var BufferConvertor = require('./lib/buffer-convertor');
+var Convertor = require('./lib/convertor');
 var LineUtil = require('./lib/line-util');
 var Char = require('./lib/char');
 
 module.exports.TreeLine = TreeLine;
 module.exports.AsciiTree = AsciiTree;
-module.exports.BufferConvertor = BufferConvertor;
+module.exports.Convertor = Convertor;
 module.exports.LineUtil = LineUtil;
 module.exports.Char = Char;

lib/asciitree-builder.js

@@ -8,18 +8,18 @@ function AsciiTreeBuilder() {
 }
 
 /**
- * @function withString
- * @param {string} str
+ * @function withContent
+ * @param {string|Buffer} content
  * @param {string} enc - string encoding.
  * @return {AsciiTreeBuilder} - return this instance.
  */
-AsciiTreeBuilder.prototype.withString = function(str, enc) {
-  this.isString = true;
-  this.content = str;
+AsciiTreeBuilder.prototype.withContent = function(content, enc) {
+  this.content = content;
   this.enc = enc;
   return this;
 };
 
+
 AsciiTreeBuilder.prototype.withEncode = function(enc) {
   this.enc = enc;
   return this;
@@ -31,9 +31,6 @@ AsciiTreeBuilder.prototype.withEncode = function(enc) {
  * @return {AsciiTree}
  */
 AsciiTreeBuilder.prototype.build = function() {
-  var bytesLines;
-  if (this.isString) {
-      bytesLines = BytesLine.getArray(this.content, this.enc);
-      return new AsciiTree(bytesLines,null, this.enc);
-  }
+  bytesLines = BytesLine.getArray(this.content, this.enc);
+  return new AsciiTree(bytesLines, null, this.enc);
 };

lib/bytes-line.js

@@ -13,6 +13,9 @@ module.exports = BytesLine;
  */
 function BytesLine(content, separator) {
   content = content || [];
+  if (Buffer.isBuffer(content)) {
+    content = LineUtil.buffer2bytes(content);
+  }
   AbstractLine.call(this, content, separator);
 }
 
@@ -97,6 +100,9 @@ BytesLine.isBytesLine = function(o) {
  * @return {BytesLine[]}
  */
 BytesLine.getArray = function(src, enc) {
+  if (!src) {
+    return [];
+  }
   var i = 0,
     code,
     lines = [],

lib/convertor-builder.js

@@ -0,0 +1,78 @@
+var BytesLine = require('./bytes-line');
+var AsciiTree = require('./ascii-tree');
+var Convertor = require('./convertor');
+
+module.exports = ConvertorBuilder;
+
+function ConvertorBuilder() {
+  this.content = null;
+}
+
+/**
+ * @function withContent
+ * @param {Buffer|string} content
+ * @param {string} enc - string encoding.
+ * @return {ConvertorBuilder} - return this instance.
+ */
+ConvertorBuilder.prototype.withContent = function(content, enc) {
+  this.content = content;
+  this.enc = enc;
+  return this;
+};
+
+/**
+ * @function withStartTag
+ * @param {string} startTag
+ * @return {ConvertorBuilder} - return this instance.
+ */
+ConvertorBuilder.prototype.withStartTag = function(startTag) {
+  this.startTag = startTag;
+  return this;
+};
+
+/**
+ * @function withEndTag
+ * @param {string} endTag
+ * @return {ConvertorBuilder} - return this instance.
+ */
+ConvertorBuilder.prototype.withEndTag = function(endTag) {
+  this.endTag = endTag;
+  return this;
+};
+/**
+ * @function withEncode
+ * @param {string} enc - encoding.
+ */
+ConvertorBuilder.prototype.withEncode = function(enc) {
+  this.enc = enc;
+  return this;
+};
+
+/**
+ * @function withPrepend
+ * @param {string|Buffer} prepend
+ * @return {ConvertorBuilder} - return this instance.
+ */
+ConvertorBuilder.prototype.withPrepend = function(prepend) {
+  this.prepend = prepend;
+  return this;
+};
+
+/**
+ * @function withAppend
+ * @param {string|Buffer} append
+ * @return {ConvertorBuilder} - return this instance.
+ */
+ConvertorBuilder.prototype.withAppend = function(append) {
+  this.append = append;
+  return this;
+};
+
+/**
+ * create an AsciiTree instance.
+ * @function build
+ * @return {AsciiTree}
+ */
+ConvertorBuilder.prototype.build = function() {
+  return new Convertor(this.content, this.startTag, this.endTag, this.prepend, this.append, this.enc);
+};