Permalink
Browse files

update readme

  • Loading branch information...
brianc committed Mar 5, 2012
1 parent 26377ae commit 01a812ae4a7350b064d59a7c27c6ee64f4105f44
Showing with 5 additions and 0 deletions.
  1. +5 −0 README.md
View
@@ -20,3 +20,8 @@ tailed(logFilePath, function(err, tail){
});
```
note: API is still in flux
+
+## things _tailed_ handles
+ - any encoding supported by node buffers
+ - tailed files getting truncated while being tailed
+ - tailed files getting deleted while being tailed (_tailed_ emits error for now)

0 comments on commit 01a812a

Please sign in to comment.