From 112d0bf83981f8ae6a63905e91ed73f7ba5b87c1 Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Thu, 5 Jan 2017 12:06:47 -0600 Subject: [PATCH] general revisions --- README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 37f11cb10..dc2c3db2e 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,16 @@ # FilterLists -FilterLists is the community-driven, independent, and comprehensive directory of all public filter lists for advertisements, trackers, and annoyances. +FilterLists is the community-driven, independent, and comprehensive directory of all public filter lists for advertisements, trackers, and annoyances. For more information on its purpose and function, check out the [Start](https://beta.filterlists.com/start/) page. ## Intro to FilterLists v2 -Version 2 of FilterLists is under live construction over at https://beta.filterlists.com. It is built on WordPress, so the entire project will not be open-sourced in this repo. But, the data and custom logic are here. +Version 2 of FilterLists is under live construction over at https://beta.filterlists.com. It is built on WordPress, so the entire project will not be open-sourced in this repo. But, the data and custom parsing logic are here to facilitate community support. ## Contributions -Issues and pull requests are welcome! More guidelines coming soon. +Pull requests and issues are welcome! Please search current issues/pull requests and peruse CONTRIBUTING.md before submitting. ## Directory Structure ### gs -Google Script custom functions, triggers, etc. Google sheets is used as a lightweight database for this project, so the .gs files contain the custom logic which converts json-data files into html as well as other functionality. +Google Script custom functions, triggers, etc. Google sheets is used as a lightweight database for this project, so the .gs files contain the custom JSON parsing logic. ### json-data -#### global.json -Lists that are actively maintained, unique, original (or fork of a stale master), and useful globally. -#### regional.json -Lists that are actively maintained, unique, original (or fork of a stale master), and useful for sites serving a specific region. -#### forked.json -Lists that are actively maintained forks of active or stale master lists. -#### combo.json -Lists that are actively maintained and combinations of two or more other lists. -#### stale.json -Lists that are no longer actively maintained. Archived for posterity. +The data in JSON form for each of the five list types on FilterLists. ### json-schema -The [JSON Schema](http://json-schema.org/) specification for each of the five list types contained in json-data. When contributing, please consult the schema files. +The [JSON Schema](http://json-schema.org/) specification for each of the five list types contained in json-data.