prehistoric-systems/FilterLists
1
0
Fork 0
mirror of https://github.com/collinbarrett/FilterLists.git synced 2026-03-11 09:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update README.md

Browse source
This commit is contained in:
Collin M. Barrett 2017-02-22 19:33:04 -06:00 committed by GitHub
parent b7178a5b17
commit 47ae0e276f
1 changed files with 12 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -9,19 +9,16 @@ FilterLists is the independent and comprehensive directory of all public filter
## Properties
| Property | Description |
|---|---|
| list | The name of the list as stated by the list maintainer(s) in title case. |
| descr | 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. |
| Property | Description |
| -------------- | ---------------------------------------- |
| descr | 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 | 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. |
| 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. |
| 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. |
| related | List names that are directly related to the list. For example, if a list is a combination of other lists, its master lists would be considered "related". Sorted alphabetically by convention. |
| tagLang | Array of ISO 639-1 language codes targeted by the list. |
## Building
Essentially, for now, you "can't". As it stands, FilterLists is only pseudo-open-sourced, built on WordPress and Google Sheets. The data is all contained in this repository in .json form. The Google Apps Scripts used to parse the data are also maintained here. To build the production setup, though, requires creating custom Google Sheets, installing the apps scripts, and installing WordPress. In the future, it would be great to have the entire site open-sourced; but, it is what it is for now.
| 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. |
| email | The email address of the list's maintainer(s) if publicly available. |
| forumUrl | The URL to the list's forum where issues, change requests, etc. are discussed. |
| 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. |
| issuesUrl | The URL to the list's GitHub Issues. |
| list | The name of the list as stated by the list maintainer(s) in title case. |
| related | List names that are directly related to the list. For example, if a list is a combination of other lists, its master lists would be considered "related". Sorted alphabetically by convention. |
| tagLang | Array of ISO 639-1 language codes targeted by the list. |
| viewUrl | The URL to the list in raw text format. zip files and other formats are acceptable if no text format is available. |