From 20a46e4e1f8aa9cd061840100de6a87b95299fe5 Mon Sep 17 00:00:00 2001 From: slashtechno <77907286+slashtechno@users.noreply.github.com> Date: Sun, 12 May 2024 15:57:14 -0500 Subject: [PATCH] Update README.md with section for contributing --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 89a136f..c6c7b15 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +For help, use the `--help` flag. +### Contributing +* [Sponsoring](https://github.com/sponsors/slashtechno) via GitHub +* Contributing code via a pull request +* Reporting encoutered issues