From 36bc82edd0829acca7f368f4db03a08ae484db81 Mon Sep 17 00:00:00 2001
From: mo khan <mo.khan@gmail.com>
Date: Thu, 17 Sep 2020 11:09:40 -0600
Subject: docs: Add examples to the README

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index ec67a3a..57fe9e2 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,45 @@
-# e2e - end to end test suite for security analyzers
+# e2e - End to end test suite for security analyzers
 
 ## Getting Started
 
+You will need the following tools installed:
+
+* [Docker][docker]
+* [asdf][asdf]
+* [git][igt]
+
+This project uses submodules to track the many different
+security product repositories.
+
+To get the project bootstrapped:
+
 ```bash
 $ git clone --recursive git@gitlab.com:xlgmokha/e2e.git
 $ cd e2e
 $ asdf install
 $ ./bin/setup
+```
+
+To run the full test suite:
+
+```bash
 $ ./bin/test
 ```
+
+To run a specific test:
+
+```bash
+$ ./bin/test spec/integration/gemnasium_maven_spec.rb:14
+```
+
+Export `DEBUG=true` to debug a specific test by lauching a shell in the Docker container:
+
+```bash
+$ DEBUG=true ./bin/test spec/integration/gemnasium_maven_spec.rb:14
+```
+
+Happy hacking!
+
+[asdf]: https://asdf-vm.com/
+[docker]: https://www.docker.com/
+[git]: https://git-scm.com/
-- 
cgit v1.2.3