From 1a44fbcbc037aed8533586cfd4ff3f02e8971fac Mon Sep 17 00:00:00 2001 From: Gabriel Llamas Date: Thu, 13 Dec 2012 09:34:30 +0100 Subject: [PATCH] updated readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 20d414d..6749cac 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,6 @@ Returns the `Writer` instance for chaining methods. __Writer#writeln(data[, offset[, length]])__ -Does the same than `write()` but stringifies the data and concatenates an EOL, OS dependent, `\r\n` on Windows, `\n` otherwise. +Does the same as `write()` but stringifies the data and concatenates an EOL, OS dependent, `\r\n` on Windows, `\n` otherwise. The offset and length specifies the slice of the given piece of data that will be written. By default offset is 0 and length is the last byte/character. The offset and length are applied to the string characters, not the bytes, for example, `write("↑a", 1)` will write `a` because offset is 1. Take into account that `↑` is encoded with 3 bytes in utf8. \ No newline at end of file