slashtechno
/
cloudflare-gateway-adblocking
mirror of https://github.com/slashtechno/cloudflare-gateway-adblocking.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md with section for contributing

This commit is contained in:
slashtechno 2024-05-12 15:57:14 -05:00 committed by GitHub
parent e719461e3c
commit 20a46e4e1f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -35,7 +35,7 @@ The following command line flags can be used to set the Cloudflare credentials:
* Cloudflare Token: `--token` / `-t`
#### Passing blocklists
Blocklists can be passed to the program via the command line flag `--blocklist` / `-b`. This flag can either point to a hosts file or a directory containing hosts files. If this flag is not passed, the program will look for a file or directory named `blocklists` in the current working directory.
# Passing whitelists
#### Passing whitelists
Whitelists can be passed to the program via the command line flag `--whitelist` / `-w`. This flag can either point to a hosts file or a directory containing hosts files. If this flag is not passed, then if a file or directory named `whitelists` exists in the current working directory, it will be used. Domains in this whitelist will be excluded from the blocklists.
#### Uploading blocklists and creating a firewall policy
To upload the blocklists to Cloudflare and create a firewall policy, use the `upload` subcommand.
@ -46,4 +46,8 @@ To delete the blocklists from Cloudflare and delete the firewall policy, use the
For example:
`cloudflare-gateway-adblocking delete`
### Help
For help, use the `--help` flag.
For help, use the `--help` flag.
### Contributing
* [Sponsoring](https://github.com/sponsors/slashtechno) via GitHub
* Contributing code via a pull request
* Reporting encoutered issues