diff --git a/tool/cfdomains/README.md b/tool/cfdomains/README.md index db7137bf9e..a8c35429bf 100644 --- a/tool/cfdomains/README.md +++ b/tool/cfdomains/README.md @@ -1,19 +1,53 @@ # CfDomains -### v1.0.4.1 -CLI tool to look up Cloudflare domain list +`CfDomains` is a simple CLI tool to: + +- Look up Cloudflare domain list, offline or online +- Replace CF links in your writings (text, HTML and Markdown) +- Categorise the domain list +- Join as warrior to help our mission -- [Linux](https://git.disroot.org/dCF/deCloudflare/raw/branch/master/tool/cfdomains/cfdomains.linux?inline=false) +### What is CfDomains Warrior? + +You can run the `CfDomains Warrior` (`cfdomains --warrior`) mode to help with the Crimeflare domain verification efforts. +It will download some domains from us, do some simple test and report back to us - it is really easy to use! + +There is no security risk to your computer because it just do DNS lookup test. +The warrior will only use your DNS server, so no CPU nor memory will be used. +It will get tasks from Karma and report the result back to Karma. + +The Warrior runs on Linux, Windows and macOS. You can run it on anything like virtual machiene as +long as it can use _clean_ DNS. + + +### Installing and Uninstalling + +- Linux: Installing ``` wget https://git.disroot.org/dCF/deCloudflare/raw/branch/master/tool/cfdomains/cfdomains.linux \ -O /usr/local/bin/cfdomains chmod +x /usr/local/bin/cfdomains cfdomains ``` - - [Windows](https://git.disroot.org/dCF/deCloudflare/raw/branch/master/tool/cfdomains/cfdomains.exe?inline=false) - - [Mac OS](https://git.disroot.org/dCF/deCloudflare/raw/branch/master/tool/cfdomains/cfdomains.app?inline=false) +- Linux: Uninstalling +``` +rm -f /usr/local/bin/cfdomains +rm -r .cfdomains_conf +``` + +- Windows + - Install: Just run the executable, this is portable. + - Uninstall: Just delete the file and `.cfdomains_conf`(configuration) file. + + +### Download +Current Version: **1.0.4.1** + +- [Linux](https://git.disroot.org/dCF/deCloudflare/raw/branch/master/tool/cfdomains/cfdomains.linux?inline=false) +- [Windows](https://git.disroot.org/dCF/deCloudflare/raw/branch/master/tool/cfdomains/cfdomains.exe?inline=false) +- [Mac OS](https://git.disroot.org/dCF/deCloudflare/raw/branch/master/tool/cfdomains/cfdomains.app?inline=false) - Source - [source.js](source.js) - e.g. `# apt install npm nodejs; npm i node-libcurl --save; nodejs source.js`