README.md in nvd_feed_api-0.0.1.rc1 vs README.md in nvd_feed_api-0.0.1.rc2
- old
+ new
@@ -1,11 +1,36 @@
[](https://www.codacy.com/app/noraj1337/nvd_api?utm_source=github.com&utm_medium=referral&utm_content=noraj1337/nvd_api&utm_campaign=Badge_Grade)
+[](https://badge.fury.io/rb/nvd_feed_api)
# nvd_feed_api
+**nvd_feed_api** is a simple ruby API for NVD CVE feeds.
+
+The API will help you to download and manage NVD Data Feeds, search for CVEs, build your vulerability assesment platform or vulnerability database.
+
Name | Link
--- | ---
Website | [link](#)
+Documentation | [link](http://www.rubydoc.info/gems/nvd_feed_api/)
+Gem | [link](https://rubygems.org/gems/nvd_feed_api)
Git repository | [link](https://gitlab.com/noraj/nvd_api)
Merge Requests | [link](https://gitlab.com/noraj/nvd_api/merge_requests)
Issues | [link](https://gitlab.com/noraj/nvd_api/issues)
Wiki | [link](https://gitlab.com/noraj/nvd_api/wikis/home)
+
+{include:file:pages/FEATURES.md}
+
+# Installation
+
+See installation steps for {file:pages/INSTALL.md#Production production / users} or {file:pages/INSTALL.md#Development development / developers}.
+
+# Examples
+
+Some frequent use cases can be found on the {file:pages/EXAMPLES.md example page}.
+
+# Contributing
+
+See {file:.gitlab/CONTRIBUTING.md the contribution guidelines}.
+
+# License
+
+See {file:LICENSE.txt}.