From 17ecf93e178939c1ea55585bae91b77ebdaff5e2 Mon Sep 17 00:00:00 2001 From: LogMANOriginal Date: Sat, 13 Aug 2016 13:44:32 +0200 Subject: [PATCH] Add introduction, goals and requirements --- Home.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 589aa5e..b567e06 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,19 @@ -Welcome to the rss-bridge wiki! +**RSS-Bridge** is free and open source software for generating ATOM or RSS feeds from websites which don't have one. It is written in PHP and intended to run on a Web server. + +# Goals of the project + +**RSS-Bridge** aims at sites that: + + - don't provide public accessible ATOM or RSS feeds + - force their users to subscribe to e-mail notifications + - force their users to use their own proprietary APIs + - require their users to come back on a regular basis in order to check for new content + +**RSS-Bridge** will generate feeds based on "bridges" that are developed for any site. Those bridges will collect data and extract all necessary information which is then converted into various feed formats like ATOM or RSS. + +# Requirements + +**RSS-Bridge** requires a Web server with: + + - PHP 5.4 (or higher) + - `openssl` extension enabled in PHP configuration (`php.ini`)