diff --git a/README.md b/README.md index 1ccba7f89..37f11cb10 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,15 @@ # FilterLists FilterLists is the community-driven, independent, and comprehensive directory of all public filter lists for advertisements, trackers, and annoyances. -## Architecture +## 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. + +## Contributions +Issues and pull requests are welcome! More guidelines coming soon. + +## 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. ### json-data #### global.json Lists that are actively maintained, unique, original (or fork of a stale master), and useful globally.