diff --git a/CREATE_BRIDGE.md b/CREATE_BRIDGE.md index 215ae282..50333036 100644 --- a/CREATE_BRIDGE.md +++ b/CREATE_BRIDGE.md @@ -20,4 +20,73 @@ The RSS elements are stored in the class variable `items[]`. Every RSS element is an instance of the `Item` class. +##The `loadMetadatas` function +This function is the one used by rss-bridge core to determine the name, maintainer name, website, last updated date... of the bridge, and the user parameters. + +### Basic metadatas. + +The basic metadatas are the following : + +```PHP +$this->maintainer +$this->name +$this->uri +$this->description +$this->update +``` + +The default values are the following : + +```PHP +$this->name = "Unnamed bridge"; +$this->uri = ""; +$this->description = 'No description provided'; +$this->maintainer = 'No maintainer'; +``` + +### Parameters + +Parameters use a JSON-like format, which is parsed and transformed to HTML `