From f458c85874c438d4cd177d27398485241d34b296 Mon Sep 17 00:00:00 2001
From: Dariush Hasapour <d.hasanpour@virtux.nl>
Date: Mon, 6 Apr 2020 12:48:49 +0430
Subject: [PATCH] README.md updated

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 51 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index a392c7f..54432d7 100644
--- a/README.md
+++ b/README.md
@@ -3,22 +3,66 @@ Lizard
 
 A lightweight and efficient C++ testing package.
 
+Demo
+---
+![lizard C++ testing package demo](demo.gif)
+
+
+```bash
+git clone https://github.com/alphamarket/lizard.git
+cd lizard
+mkdir build && cd build
+cmake .. && make
+./test
+```
+
+```c++
+// lizard/tests/sample_tester.hpp
+#ifndef SAMPLE_TESTER_HPP
+#define SAMPLE_TESTER_HPP
+
+#include "lizard/lizard.hpp"
+
+TESTER(sample_tester,
+
+    spec(sum, []() {
+        IS_EQUAL(1 + 2, 3);
+    });
+    
+    spec(multiply, []() {
+        SKIP_WITH_MESSAGE("SKIP WITH MESSAGE");
+    });
+    
+    spec(minus, []() {
+        IS_EQUAL(1 - 2, -1);
+    });
+
+    spec(faulty, []() {
+        IS_EQUAL(2 / 2, -1);
+    });
+
+    spec(divide, []() {
+        IS_EQUAL(2 / 2, 1);
+    });
+)
+
+#endif
+```
+
+
 Prerequisites
 ---
 No prerequisites is needed. The project is as is.
 
-How to step up?
+How to step up in your project?
 -----
 Assume you have a project named `cppApp` written in C++.
 
-There is a [setup script](https://raw.githubusercontent.com/noise2/lizard/master/lizard-setup) provided to make cloning this C++ Tester repository into your project easier
+There is a [setup script](https://raw.githubusercontent.com/alphamarket/lizard/master/lizard-setup) provided to make cloning this C++ Tester repository into your project easier
 
 ```BASH
 cd "/path/to/cppApp"
-curl https://raw.githubusercontent.com/noise2/lizard/master/lizard-setup | bash
+curl https://raw.githubusercontent.com/alphamarket/lizard/master/lizard-setup | bash
 # That is it.
+cd test
 ```
-
-Demo
----
-For demo download/clone [this](https://github.com/noise2/lizard-demo).