From 278085c6b96981143b57143ff4b66e428d8eb635 Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Thu, 2 Feb 2017 15:27:57 -0600 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 0f71b50bf..192eacd65 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,37 @@ FilterLists is the independent and comprehensive directory of all public filter lists for advertisements, trackers, malware, and annoyances. For more information on its purpose and function, check out [Start](https://filterlists.com/start/). +## Types & Properties + +List Types: + - **Global**: Lists that are actively maintained, unique, original (or fork of a stale master), and useful globally. + - **Regional**: Lists that are actively maintained, unique, original (or fork of a stale master), and useful for sites serving a specific region. + - **Forked**: Lists that are actively maintained forks of active or stale master lists. + - **Combo**: Lists that are actively maintained and combinations of two or more other lists. + - **Stale**: Lists that are no longer actively maintained. Archived for posterity. + +Matrix Key: + - X : Required + - ? : Optional + - ( ) : Not Available/Not Supported + +| | Global | Regional | Forked | Combo | Stale | Description | +|---|---|---|---|---|---|---| +| list | X | X | X | ? | X | The name of the list as stated by the list maintainer(s) in title case. | +| lang | | X | ? | | ? | The comma-separated list of ISO 639-1 codes targeted by the list. | +| descr | X | X | X | | X | A brief description of the list's functionality. Preferably, this is quoted (if non-English, translate to English via translator or Google Translate for consistency) from the list's documentation or composed by a maintainer of the list. If neither are available, a generic description should be composed by the FilterLists contributor. | +| descrSourceUrl | ? | ? | ? | | ? | The URL to the list's documentation page from which the description was quoted if applicable. | +| viewUrl | X | X | X | X | X | The URL to the list in raw text format. zip files and other formats are acceptable if no text format is available. | +| homeUrl | ? | ? | ? | | ? | The URL to the list's home page. Preferably, this is stated in the header of the list. Alternatively, it could be a custom domain, GitHub page, blog post, forum post, etc. that serves as a primary source of information for the list. | +| guideUrl | ? | ? | ? | | ? | The URL to the list's instruction guide if it is significantly different than the homeUrl. | +| forumUrl | ? | ? | ? | | ? | The URL to the list's forum where issues, change requests, etc. are discussed. | +| issuesUrl | ? | ? | ? | | ? | The URL to the list's GitHub Issues. | +| email | ? | ? | ? | | ? | The email address of the list's maintainer(s) if publicly available. | +| changelogUrl | ? | ? | ? | | ? | The URL to the list's changelog such as an RSS feed, GitHub commits log, Mercurial log, etc. | +| donateUrl | ? | ? | ? | | ? | The URL to the list's donation page. This could be a custom PayPal or similar link, or a link to a web page discussing various donation options. Pull requests that include changes to this link will undergo further verification to prevent fraud. | +| forksCombos | ? | ? | | | ? | List names that are either a fork or a combo of list. Sorted alphabetically by convention. | +| master | | | X | X | | List names which are combined to create the list (if a combo) or list name from which the list is forked (if a fork). Sorted alphabetically by convention. | + ## Contributions See [CONTRIBUTING](https://github.com/collinbarrett/FilterLists/blob/master/CONTRIBUTING.md).