Tweaking the documentation for the source argument.

emberfeather · Mar 28, 2012 · 66f7c7a · 66f7c7a
1 parent 6763937
commit 66f7c7a
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/readme.md b/readme.md
@@ -79,11 +79,11 @@ _Note:_ The following example uses the [`request`][1] package to simplify the ht
 
 ## Module
 
-### xml2object(elements, source)
+### xml2object(elements[, source])
 
 Constructor for creating an instance of the xml parser.
 
-The source argument is optional and can be a path to an xml file or an input stream.
+The source argument is can be a path to an xml file or an input stream.
 
 If no source is specified you can set a readable Stream to `.source` or pipe a Stream into the `.saxStream`.
 
@@ -94,7 +94,7 @@ If no source is specified you can set a readable Stream to `.source` or pipe a S
 
 ### .source
 
-The input Stream used as a source for parsing.
+The input Stream used as a source for parsing. Can be set to a xml file path or a readable stream.
 
 ### .saxStream