Skip to content

Commit e083b1a

Browse files
committed
Added documentation for appendString, appendBuffer
1 parent 3afdfc7 commit e083b1a

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

ReadMe.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you are thinking about using this, you should probably have considered stream
1010
var BufferBuilder = require('buffer-builder');
1111
var helloWorld = new BufferBuilder();
1212

13-
// Append a string, ascii encoded by default.
13+
// Append a string, utf8 encoded by default.
1414
helloWorld.appendString('hello');
1515

1616
// Append any type that Buffer has read and write functions for.
@@ -34,6 +34,10 @@ buffer.toString(); // hello world!!!
3434
Allocate an empty BufferBuilder. If you know approximately what size the Buffer will end up being and are trying to squeeze out more performance, you can set the initial size of the backing buffer.
3535

3636
### appendBuffer(source)
37+
Append a buffer. Use [slice](http://nodejs.org/docs/latest/api/buffers.html#buffer.slice) if you want to append just part of one.
38+
39+
### appendString(string, [encoding])
40+
Append a string, encoded by utf8 by default. No trailing 0 is appended.
3741

3842
### appendUInt8(value)
3943
Append 8-bit unsigned integer.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"main" : "buffer-builder",
66
"repository" : {
77
"type" : "git",
8-
"url" : "http://github.com/peter.d.reid/buffer-builder.git"
8+
"url" : "http://github.com/PeterReid/buffer-builder.git"
99
},
1010
"keywords" : [
1111
"buffer-builder", "buffer"

0 commit comments

Comments
 (0)