From 9f6d22421aa82eeea5e80a0b7186851c754d66ba Mon Sep 17 00:00:00 2001 From: "Lee Taewoo(ted)" Date: Fri, 15 Jul 2016 15:50:07 +0900 Subject: [PATCH] Update README.md fix misleading explanation There are some mismatches between document options and source code options when you initialize new Tail("fileToTail",options) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f3826ce..d5b09b1 100644 --- a/README.md +++ b/README.md @@ -45,14 +45,14 @@ new Tail(fileToTail) Optional parameters can be passed via a hash: ```javascript -var options= {lineSeparator: /[\r]{0,1}\n/, fromBeginning: false, watchOptions: {}, follow: true, logger: console} +var options= {separator: /[\r]{0,1}\n/, fromBeginning: false, watchOptions: {}, follow: true, logger: console} new Tail(fileToTail, options) ``` # Available parameters: -* `lineSeparator`: the line separator token (default `/[\r]{0,1}\n/` to handle linux/mac (9+)/windows) -* `watchOptions`: the full set of options that can be passed to `fs.watch` as per node documentation (default: {}) +* `separator`: the line separator token (default `/[\r]{0,1}\n/` to handle linux/mac (9+)/windows) +* `fsWatchOptions`: the full set of options that can be passed to `fs.watch` as per node documentation (default: {}) * `fromBeginning`: forces the tail of the file from the very beginning of it instead of from the first new line that will be appended (default: `false`) * `follow`: simulate `tail -F` option. In the case the file is moved/renamed (or logrotated), if set to `true` `tail` will try to start tailing again after a 1 second delay, if set to `false` it will just emit an error event (default: `true`) * `logger`: a logger object(default: no logger). The passed logger has to respond to two methods: @@ -80,4 +80,4 @@ Tail is written in [CoffeeScript](http://jashkenas.github.com/coffee-script/). The Cakefile generates the javascript that is then published to npm. #License -MIT. Please see License file for more details. \ No newline at end of file +MIT. Please see License file for more details.