summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormo khan <mo.khan@gmail.com>2020-09-17 10:46:46 -0600
committermo khan <mo.khan@gmail.com>2020-09-17 10:46:46 -0600
commitbfc112de89bb437594f9425c6e5aa6c16ba85109 (patch)
tree146cd63f04c1fb8c0d6f64ec90df5d8bab41c428 /README.md
parent42d32612235861c2b94b861f535f248216668f3b (diff)
docs: add project README
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ec67a3a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# e2e - end to end test suite for security analyzers
+
+## Getting Started
+
+```bash
+$ git clone --recursive git@gitlab.com:xlgmokha/e2e.git
+$ cd e2e
+$ asdf install
+$ ./bin/setup
+$ ./bin/test
+```