lightair/turbo-rss
1
0
Fork 0
mirror of https://github.com/LightAir/turbo-rss.git synced 2026-02-04 12:06:20 +00:00
Code Issues Projects Releases Wiki Activity

updated usage.md with latest updates

Browse Source
This commit is contained in:
Andreas Schmid
2015-02-09 11:59:46 -05:00
parent a0e24d83ab
commit 04c3dd32c7
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
templates/readme/usage.md
View File

@@ -55,7 +55,25 @@ feed.item(itemOptions);
* `lat` _optional_ **number** The latitude coordinate of the item. * `lat` _optional_ **number** The latitude coordinate of the item.
* `long` _optional_ **number** The longitude 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) * `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 #### Feed XML
```js ```js