README.md in fidius-cvedb-0.0.2 vs README.md in fidius-cvedb-0.0.3

- old
+ new

@@ -1,20 +1,20 @@ # FIDIUS fidius-cvedb -The FIDIUS CVE-DB Gem is used to create and run your own vulnerability database, -or as an addition to the FIDIUS Command&Control Server to receive vulnerability -information about target hosts. It uses the National Vulnerability Database -(NVD [nvd.nist.gov](http://nvd.nist.gov/)) to gather vulnerability entries -which are based on the Common Vulnerabilities and Exposures (CVE) identifiers. +The FIDIUS CVE-DB Gem is used to run your own vulnerability database, +based on the National Vulnerability Database (NVD +[nvd.nist.gov](http://nvd.nist.gov/)). It can be used for projects +that need access to vulnerability information, such as the Common +Vulnerabilities and Exposures (CVE) identifiers. -Therefore it includes rake tasks to download and parse XML files provided by the +It includes rake tasks to download and parse XML files provided by the NVD, to store and update them in your personal database. Furthermore it includes ActiveRecord models, migrations and example database configuration to store Vulnerabilities easily. -This gem is developed in the context of the students project "FIDIUS" at the -University of Bremen, for more information about FIDIUS visit +This gem is being developed in the context of the student project "FIDIUS" at the +Universitaet Bremen; for more information about FIDIUS visit [fidius.me](http://fidius.me/en). ## Installation Simply install this package with Rubygems: @@ -36,11 +36,11 @@ not work with Windows. ## Configuration The setup depends on the context you want to use the gem. It can be used in the -context of the FIDIUS Command&Control Server, or in your own Rails-app. It might +context of the FIDIUS Command&Control Server, or in your own Rails app. It might access an already existing database or migrate a new one. 0. Go to your Rails-app folder and run `fidius-cvedb --standalone` or `fidius-cvedb --fidius`, depending on the context you are using it. For Rails versions prior 3 this will create symlinks for the Rake tasks. @@ -59,16 +59,16 @@ 2. When you created a new database, run `rake nvd:migrate` to create the tables needed. 3. When you set up your own database initialize it (note that it needs to be migrated before). Go to your Rails-app folder and run - `rake nvd:initialize`. This will download all available informations from the + `rake nvd:initialize`. This will download all available information from the NVD, parse and store it in your database. This takes about 3 hours, depending on your machine. To keep your database up-to-date run `rake nvd:update` - regularly, e.g. as daily cronjob. -4. Now you should be able to use the NVD Entries, to test this go to your - console (`rails console` | `ruby script/console`) and get an Entry: + regularly, e.g. as a daily cron job. +4. Now you should be able to use the NVD entries, to test this go to your + console (`rails console` | `ruby script/console`) and get an entry: $ FIDIUS::CveDb::NvdEntry.first ## Synopsis @@ -88,17 +88,17 @@ ## Authors and Contact fidius-cvedb was written by * FIDIUS Intrusion Detection with Intelligent User Support - <grp-fidius@tzi.de>, <http://fidius.me> + <grp-fidius+cvedb@tzi.de>, <http://fidius.me> * in particular: * Andreas Bender <bender+fidius-cvedb@tzi.de> * Jens Färber <jfaerber+fidius-cvedb@tzi.de> If you have any questions, remarks, suggestion, improvements, etc. feel free to drop a line at the addresses given above. -You might also join `#fidius` on Freenode or use the contact +You might also join [`#fidius` on Freenode](irc://irc.freenode.net/fidius) or use the contact form on our [website](http://fidius.me/en/contact). ## License