Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 3.4 KB

README.en.md

File metadata and controls

75 lines (51 loc) · 3.4 KB
Raw

Patches for Taberareloo

Here is a patch repository for Taberareloo.

Requirements

Filename

A patch for Taberareloo must have an extension .tbrl.js. Otherwise, it won't be installed.

The file name is a key in the Taberareloo patch system, so it must be unique in the entire system.

Metadata

A patch must have a metadata about its patch.

// ==Taberareloo==
// {
//	 "name"        : "Patch Name"
// , "description" : "Patch Description"
// , "include"     : ["background", "content"]
// , "match"       : ["https://*/*"]
// , "version"     : "1.0.0"
// , "downloadURL" : "https://raw.github.com/taberareloo/patches-for-taberareloo/master/patches/patch_file_name.tbrl.js"
// }
// ==/Taberareloo==

  • The metadata area in a patch must start with // ==Taberareloo== line and end with // ==/Taberareloo== line.

  • The metadata is a JSON format led by // at each line and commented out.

  • Each key and value must be quoted by double-quote "".

  • "name" : The name of a patch (optional)

  • "description" : The description of a patch (optional)

  • "include" : An array of target contexts ("background", "content", "popup" and/or "options")
    "background" : The background context of Taberareloo
    "content" : A page context opened in a browser tab
    "popup" : The popup window in which the QuickPostForm is (v3.0.1~)
    "options" : The option page (v3.0.3~)

  • "match" : An array of target page patterns, if "include" has "content".
    The match patterns are equivalent of Match Patterms of Google Chrome.
    If "include" doesn't have "content", it's ignored.

  • "version" : The version of a patch (optional)
    The version format uses Semantic Versioning.

  • "downloadURL" : A URL where a patch can be found and installed (optional)
    Taberareloo uses this URL and "version" to check updates of its patch and notifies it to you.

Installation

A patch can be installed by right-clicking and selecting Patch - Install this in the Taberareloo context menu on a remote file like "downloadURL", or from a local file at the Patch tab in the options page of Taberareloo.

Updates Notification

If the metadata in a patch has "downloadURL" and "version", Taberareloo will check updates of its patch automatically by comparing "version" in "downloadURL" and "version" in the installed patch. And also users can check manually by clicking the button "Check Updates" at the Patch tab in the options page of Taberareloo.

Contributing

  1. Fork it.
  2. Create a branch (git checkout -b my_patch)
  3. Commit your changes (git commit -am "Added My Patch")
  4. Push to the branch (git push origin my_patch)
  5. Open a Pull Request