Add introduction, goals and requirements

LogMANOriginal 2016-08-13 13:44:32 +02:00
parent 71d304fa23
commit 17ecf93e17

20
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`)