From 04c3dd32c782c83daf5a99e4e04af8534e192029 Mon Sep 17 00:00:00 2001 From: Andreas Schmid Date: Mon, 9 Feb 2015 11:59:46 -0500 Subject: [PATCH] updated usage.md with latest updates --- templates/readme/usage.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/templates/readme/usage.md b/templates/readme/usage.md index fe0528e..c2a9304 100644 --- a/templates/readme/usage.md +++ b/templates/readme/usage.md @@ -55,7 +55,25 @@ feed.item(itemOptions); * `lat` _optional_ **number** The latitude coordinate of the item. * `long` _optional_ **number** The longitude coordinate of the item. * `custom_elements` _optional_ **array** Put additional elements in the item (node-xml syntax) + * `enclosure` _optional_ **object** An enclosure object + ```js + /* enclosure takes url or file key for the enclosure object + url: _required_ url to file object (or file) + file: _required_ path to binary file (or url) + size: _optional_ size of the file + type: _optional_ if not provided the mimetype will be guessed + based on the extension of the file or url, + passing type to the enclosure will override the guessed type + */ + + { + 'url' : 'http://www.example.com/path/to/image', + 'size' : 1668, // + 'type' : 'image/jpeg' + } + + ``` #### Feed XML ```js