Permalink
Browse files

Updated documentation for underlying_type and others

  • Loading branch information...
1 parent d8cd4b9 commit 9ceeda2a1d262fa991e379bf634eaf2cae15b2a2 amix committed Apr 22, 2014
Showing with 13 additions and 0 deletions.
  1. +13 −0 README.md
View
@@ -35,6 +35,19 @@ media_parser.parse('This is a test http://www.youtube.com/watch?v=9bZkp7q19f0',
}
```
+## Result description
+```js
+// Example
+{
+ "title": "...",
+ "underlying_type": ... can be: [page, image, video, audio] ,
+ "content_url": ... direct link to the content (only for some),
+ "content_type": ... MIME type of content_url,
+ "raw": ... raw oEmbed response (only for oEmbed resources),
+ "get_thumbnail_url": function(min_size) { ... returns thumbnail }
+}
+```
+
## Other useful functions

0 comments on commit 9ceeda2

Please sign in to comment.