Merge pull request #6 from kangoo13/feat/module-new-checkers#4

docs: Update README

Author: kangoo13

README.md

@@ -1,29 +1,44 @@
-# cloudflare-proxy-ban-checker
+# proxy-checker
 
-Checks a set of proxies against a protected CloudFlare website to check if the proxies are banned or not.
+Check for a set of proxies different conditions, is the proxy working, does the proxy bypass cloudflare and so on.
+This project is using GoColly as main engine.
+
+# Features
+
+- Checks if the proxy is working
+- Checks if the proxy bypass a website protected by CloudFlare
 
 # Installation
 
 Very simple :
 
 ```
-git clone git@github.com:kangoo13/cloudflare-proxy-ban-checker.git
-cd cloudflare-proxy-ban-checker
+git clone git@github.com:kangoo13/proxy-checker.git
+cd proxy-checker
 go build
-./cloudflare-proxy-ban-checker -h
-Usage: cloudflare-proxy-ban-checker [--goodproxiespath GOODPROXIESPATH] [--badproxiespath BADPROXIESPATH] [--timeoutproxy TIMEOUTPROXY] WEBSITE PROXYLIST
+./proxy-checker -h
+Usage: proxy-checker [--timeoutproxy TIMEOUTPROXY] [--cloudflarebypass] [--basic] [--websitecloudflare WEBSITECLOUDFLARE] PROXYLIST GOODPROXIESPATH
 
 Positional arguments:
-  WEBSITE                website to test proxy against cloudflare
   PROXYLIST              path to the proxyList
+  GOODPROXIESPATH        path to the good proxies identified
 
 Options:
-  --goodproxiespath GOODPROXIESPATH
-                         path to the good proxies identified [default: good.txt]
-  --badproxiespath BADPROXIESPATH
-                         path to the bad proxies identified [default: bad.txt]
-  --timeoutproxy TIMEOUTPROXY
-                         timeout proxy duration [default: 5]
+  --timeoutproxy TIMEOUTPROXY, -t TIMEOUTPROXY
+                         timeout proxy duration in seconds [default: 4]
+  --cloudflarebypass, -c
+                         if activated, check if proxy bypass cloudflare
+  --basic, -b            if activated, simply checks if proxy is working [default: true]
+  --websitecloudflare WEBSITECLOUDFLARE, -w WEBSITECLOUDFLARE
+                         website to test proxy against cloudflare, needed if -cf
   --help, -h             display this help and exit
+
 ```
 
+# Contribution
+
+Implementing new checkers or enhancing them is welcome !
+
+# Chat
+
+Feel free to speak with me on FreeNode IRC, my nickname is kangoo13