diff --git a/README.md b/README.md index df0772f..afef43d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ -# Installation +# Grade Management - An Intentionally Vulnerable Rails Application + +Grade Management is an **intentionally vulnerable** grade management application that can +be used for teaching *security testing* and *security programming*. + +Grade Management implements a simplistic system for managaing university grade, i.e., students +can check their marks and academics can enter marks. + +## Installation Make sure that you have `ruby` and `ruby-bundler` installed. Then, run the following in the grademgmt directory: -``` +```bash bundle install --path vendor/bundle ``` -# Starting the server +## Starting the server To start the development server, run the following: -``` +```bash bin/rails server ```