diff --git a/README.md b/README.md index c607d24..ad3335b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # data_importer -Import common security data such as CVE, CPE, and Security Advisories from various CNAs into a rails app with a postgresql db backend. +This is a rails/postgres application that will serve json data from the following data sources: +- Cves +- Cpes +- CNA Security Advisories +- Github repositories that track public exploits for Cves. + +Check the HTTP API section below for specific endpoints that can be queried via http. ## Supported data models: - `Cve` data from [cve_list](https://github.com/CVEProject/cvelist) github repo.