add option to inline logos
[mygpo-feedservice.git] / feedservice / index.html
blobd4c4152123bd9ea7f71d417a37f8502f0cf2d71f
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <title>gpodder.net Feed-Service</title>
6 </head>
8 <body>
9 <h1>gpodder.net Feed-Service</h1>
11 <p>The gpodder.net Feed-Service is a webservice for parsing podcast feeds and
12 returning the simplified contents as JSON.</p>
14 <h2>Usage</h2>
15 <p>Parameters to /parse
16 <ul>
17 <li><strong>url</strong>: The URL of the feed that should be parsed (required)</li>
18 <li><strong>inline_logo</strong>: If set to 1, the (unscaled) logos are included in the response as <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URIs</a> (default 0).</li>
19 </ul>
20 </p>
22 <p>Examples:
23 <pre><strong>
24 <a href="/parse?url=http://feeds.feedburner.com/linuxoutlaws&inline_logo=1">GET /parse?url=http://feeds.feedburner.com/linuxoutlaws&inline_logo=1</a>
25 <a href="/parse?url=http://leo.am/podcasts/floss&url=http://feeds.twit.tv/floss_video_large">GET /parse?url=http://leo.am/podcasts/floss&url=http://feeds.twit.tv/floss_video_large</a>
26 </strong></pre>
27 </p>
29 <p>If you intend to use <em>this instance</em> of the webservice in your
30 application, please contact <a
31 href="mailto:stefan@skoegl.net">stefan@skoegl.net</a> beforehand.
33 <h2>Source Code</h2>
34 <p>The sourcecode is available from <a
35 href="http://repo.or.cz/w/mygpo-feedservice.git">http://repo.or.cz/w/mygpo-feedservice.git</a>
36 under the terms of the GPLv3.</p>
39 </body>
40 </html>