diff --git a/README.md b/README.md index e9e12beba..299e25ee6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # FilterLists FilterLists is the community-driven, independent, and comprehensive directory of all public filter lists for advertisements, trackers, and annoyances. + +## Architecture +### 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. +### json-schema +The json-schema.org specification for each of the five list types contained in json-data. When contributing, please consult the schema files.