Update README.md

README.md

@@ -1,38 +1,87 @@
-# [Vulners](https://vulners.com) API v3 Python wrapper
-Vulners Python API wrapper
+# [Vulners API v3](https://vulners.com) Python wrapper
+
+
+# Description
+Python 2/3 library for the [Vulners Database](https://vulners.com).
+It provides *search, data retreival, archive and vulnerability scanning* API's for the integration purposes.
+With this library you can create powerfull security tools and get access to the world largest security database.
+
+## Python version
+Library was tested on a *python2* and *python3*.
+
+## How to install
+
+Package is available with [PyPI](https://pypi.python.org/pypi) 
+
+You can use pip for the installation
 
 ```
-# mkdir vulnersapi
-# cd vulnersapi
-# git clone https://github.com/vulnersCom/api
-# pip install -U -e api
+pip install -U vulners
 ```
 
-# Examples
+# Functions and methods
+
+All the callable methods are using [Vulners REST API](https://vulners.com/docs).
 
-Search api usage
+### Search in database
 ```
 import vulners
 
 vulnersApi = vulners.Vulners()
 heartbleed_related = vulnersApi.search("heartbleed", limit=10)
+```
+### Get information about document by identificator
+```
+import vulners
+
+vulnersApi = vulners.Vulners()
 CVE_2017_14174 = vulnersApi.document("CVE-2017-14174")
 ```
+### Search for the public available exploits
+```
+import vulners
 
-Software vulnerabilities audit 
+vulnersApi = vulners.Vulners()
+wordpress_exploits = vulnersApi.searchExploit("wordpress 4.7.0")
+```
+### Get vulnerabilities and exploits by software name and version
 ```
 import vulners
 
 vulnersApi = vulners.Vulners()
 
-# Plain text software + version example for Apache Httpd 1.5
-sw_results = vulnersApi.softwareVulnerabilities("httpd", "1.5")
-sw_exploit_list = sw_results.get('exploit')
-sw_vulnerabilities_list = [sw_results.get(key) for key in sw_results if key not in ['info', 'blog', 'bugbounty']]
+results = vulnersApi.softwareVulnerabilities("httpd", "1.5")
+exploit_list = sw_results.get('exploit')
+vulnerabilities_list = [sw_results.get(key) for key in sw_results if key not in ['info', 'blog', 'bugbounty']]
+```
+### Get vulnerabilities by CPE product and version string
+```
+import vulners
+
+vulnersApi = vulners.Vulners()
 
-# CPE vulnerability search example
 cpe_results = vulnersApi.cpeVulnerabilities("cpe:/a:cybozu:garoon:4.2.1")
 cpe_exploit_list = cpe_results.get('exploit')
 cpe_vulnerabilities_list = [cpe_results.get(key) for key in cpe_results if key not in ['info', 'blog', 'bugbounty']]
-print(cpe_results.keys())
+```
+### Get references for the vulnerability
+```
+import vulners
+
+vulnersApi = vulners.Vulners()
+references = vulnersApi.references("CVE-2014-0160")
+```
+### Score any vulnerability description using [Vulners AI](https://lab.wallarm.com/new-from-wallarm-research-first-ai-based-tool-to-predict-vulnerability-risk-2d0a7e9b3474)
+```
+import vulners
+
+vulnersApi = vulners.Vulners()
+text_ai_score = vulnersApi.aiScore("My cool vulnerability description")
+```
+### Download whole database collection and work with data locally
+```
+import vulners
+
+vulnersApi = vulners.Vulners()
+all_cve = vulnersApi.archive("cve")
 ```