mirrors/rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-04-03 23:35:51 +03:00
Code Issues Projects Releases Packages Wiki Activity

[How to create a new Bridge?] Specify file name instructions more clearly

LogMANOriginal 2016-08-24 18:47:05 +02:00
parent d351293d54
commit 0b4f6635a2
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
How-to-create-a-new-Bridge.md

@ -1,6 +1,12 @@
Create a new file in the `bridges/` folder (see [Folder structure](Folder-structure)). Create a new file in the `bridges/` folder (see [Folder structure](Folder-structure)).
The file name begins with the name of the site, followed by the word 'Bridge' and the file type PHP. The file name must be named according to following specification:
* It starts with the full name of the site
* All white-space must be removed
* The first letter of a word is written in upper-case, unless the site name is specified otherwise (example: Freenews, not FreeNews, because the site is named 'Freenews')
* The first character must be upper-case
* The file name must end with 'Bridge'
* The file type must be PHP, written in **small** letters (seriously!) ".php"
**Examples:** **Examples:**
@ -9,6 +15,7 @@ Site | Filename
Wikipedia | **Wikipedia**Bridge.php Wikipedia | **Wikipedia**Bridge.php
Facebook | **Facebook**Bridge.php Facebook | **Facebook**Bridge.php
GitHub | **GitHub**Bridge.php GitHub | **GitHub**Bridge.php
Freenews | **Freenews**Bridge.php
The file must start with the PHP tags and end with an empty line. The closing tag `?>` is [omitted](http://php.net/basic-syntax.instruction-separation). The file must start with the PHP tags and end with an empty line. The closing tag `?>` is [omitted](http://php.net/basic-syntax.instruction-separation).