diff --git a/readme.markdown b/readme.markdown index ea8ced5..1828d6a 100644 --- a/readme.markdown +++ b/readme.markdown @@ -2,12 +2,12 @@ ## Preamble -_rss\_yap\_app_ is a simple framework for generating a [Yahoo! Application Platform](http://developer.yahoo.com/yap) application from an RSS feed. This document is intended to describe usage of this project for two common scenarios: +_rss\_yap\_app_ is a collection of examples for generating a [Yahoo! Application Platform](http://developer.yahoo.com/yap) application from an RSS feed. This document is intended to describe usage of this project for two common scenarios: 1. "Porting" an app based on a [Yahoo! Front Door XSL-based template](http://public.yahoo.com/~jchu/) to YAP 2. Creating a new YAP app based on a standard RSS feed -_rss\_yap\_app_ operates by consuming a given feed, parsing the feed data using PHP's SimpleXML library, and passing the parsed data to a PHP/HTML/CSS template for rendering. In an app's description, the location of the framework is given as the base URL for the app, and the output from the template is returned back to YAP for display. Detailed installation and usage instructions are given below. +_rss\_yap\_app_ operates by consuming a given feed, parsing the feed data using PHP's SimpleXML library, and passing the parsed data to a PHP/HTML/CSS template for rendering. In an app's description, the location of the template to use is given as the base URL for the app, and the output from the template is returned back to YAP for display. Detailed installation and usage instructions are given below. ## Prerequisites @@ -24,7 +24,7 @@ _rss\_yap\_app_ operates by consuming a given feed, parsing the feed data using * Clone this repository: `git clone git://github.com/ydn/rss_yap_app.git` 2. Upload the project to your server 3. Create a new YAP application using the [YDN dashboard](http://developer.yahoo.com/dashboard) -4. Set the _Application URL_ of the app to point to the location of the _index.php_ file in the project directory on your server, e.g. http://example.com/rss\_yap_app/index.php +4. Set the _Application URL_ of the app to point to the location of the _{template}.php_ file in the project directory on your server, e.g. _http://example.com/rss\_yap\_app/standard.php_ 5. Set the _Small View Default Content_ to: