update readme file

README.md

@@ -12,6 +12,7 @@ Get Python downloaded on computer: [https://www.python.org/downloads/](https://w
 git clone https://github.com/hpcao299/McQueen.git
 cd McQueen
 pip3 install -r requirements.txt
+python3 McQueen/main.py
 ```
 
 ### Lastest release on PyPI
@@ -37,35 +38,55 @@ pip3 install McQueen
 
 -   To list all the basic options and switches use -h switch:
 
-`python3 mcqueen.py -h`
+`mcqueen -h`
 
 -   To track website information (IP, ports, nameservers,...):
 
-`python3 mcqueen.py -i https://example.com`
+`mcqueen -i https://example.com`
 
 -   To crawl all available pages of a website:
 
-`python3 mcqueen.py -p https://example.com`
+`mcqueen -p https://example.com`
 
 -   To detect a website's firewall:
 
-`python3 mcqueen.py -f https://example.com`
+`mcqueen -f https://example.com`
 
 -   To check domain age and registered date:
 
-`python3 mcqueen.py -a example.com`
+`mcqueen -a example.com`
 
 -   To enumerate subdomains of a domain:
 
-`python3 mcqueen.py -s example.com`
+`mcqueen -s example.com`
 
 -   To find domain's registrant contact information:
 
-`python3 mcqueen.py -o example.com`
+`mcqueen -o example.com`
 
 -   To trace IP address location:
 
-`python3 mcqueen.py -l 8.8.8.8`
+`mcqueen -l 8.8.8.8`
+
+### Using McQueen as a module in your python scripts
+
+#### Example
+
+```
+from McQueen import track_website_information
+
+details = track_website_information('https://example.com')
+```
+
+#### Functions
+
+-   **track_website_information**: Get website information (IP, ports, nameservers,...).
+-   **crawl_website_pages**: Crawl all available pages of a website through its sitemaps.
+-   **detect_firewall**: Detect firewall usage of website.
+-   **check_domain_age**: Investigate registered date and age of a domain.
+-   **scan_subdomain**: Enumerate subdomains of a domain.
+-   **check_domain_registrant**: Search domain's registrant / administrative contact information.
+-   **track_ip_location**: Trace IP address details and location.
 
 ## Resources
 
@@ -76,6 +97,10 @@ McQueen uses variety of available and legal resources on the Internet. Taking a
 -   DNSDumpster ([https://dnsdumpster.com](https://dnsdumpster.com))
 -   ip-api ([https://ip-api.com](https://ip-api.com))
 
+## License
+
+McQueen is licensed under the MIT license. Take a look at the [LICENSE](https://github.com/hpcao299/McQueen/blob/main-python/LICENSE) for more information.
+
 ## Contributions
 
 This tool is open for everyone and feel free to contribute if you have any development ideas.