diff --git a/Bridge-API.md b/Bridge-API.md new file mode 100644 index 0000000..efce6e6 --- /dev/null +++ b/Bridge-API.md @@ -0,0 +1,9 @@ +A _Bridge_ is an class that allows **RSS-Bridge** to create an RSS-feed from a website. A _Bridge_ represents one element on the [Welcome screen](Screenshots) and covers one or more sites to return feeds for. It is developed in a PHP file located in the `bridges/` folder (see [Folder structure](Folder-structure)) and extends one of the base classes of **RSS-Bridge**: + +Base class | Description +-----------|------------ +[`BridgeAbstract`](BridgeAbstract) | This class is intended for standard _Bridges_ that need to filter HTML pages for content. +`HttpCachingBridgeAbstract` | This class an extension of `BridgeAbstract`, allowing caching of files downloaded over HTTP files. +`RssExpander` | This class is an extension of `HttpCachingBridgeAbstract`, designed to load existing RSS 2.0 feeds into **RSS-Bridge** + +For more information about how to create a new _Bridge_, read [How to create a new Bridge?](How-to-create-a-new-Bridge%3F) \ No newline at end of file