Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Tweaking the documentation for the `source` argument.

  • Loading branch information...
commit 66f7c7ae09e28d919f0d3d7a96485eeb8e8fc03a 1 parent 6763937
@Zoramite Zoramite authored
Showing with 3 additions and 3 deletions.
  1. +3 −3 readme.md
View
6 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
Please sign in to comment.
Something went wrong with that request. Please try again.