From 6d8722758f04420a954127edd24aa5901c64f5f7 Mon Sep 17 00:00:00 2001
From: Hamer Iboshi <hi15@inf.ufpr.br>
Date: Thu, 19 Sep 2019 12:12:28 -0300
Subject: [PATCH] Update README.md

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 735d632..80d136b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
-# lde-api-regression-test
+# LDE API Regression Test #
 
+
+Regression test is a tool for validate existent functionality with each new release of code.
+
+## Getting Started
+
+### Requirements
+
+- [Python 3.5+](https://www.python.org/)
+- [pip](https://pip.pypa.io/en/stable/installing/)
+- [virtualenv](https://virtualenv.pypa.io/en/latest/installation/)
+
+### Installation
+
+Clone this repository
+
+```
+git clone git@gitlab.c3sl.ufpr.br:simcaq/lde-api-regression-test.git
+```
+Go to this repository
+```
+cd lde-api-regression-test
+```
+Create a virtual environment
+```
+virtualenv -p python3.5 env
+```
+Activate the virtual environment
+```
+source env/bin/activate
+```
+Install dependencies
+```
+pip install -r requirements.txt
+```
+
+## Usage
+
+### Set settings.py
+
+Set base url to the running API (local ex.: localhost:PORT):
+
+```
+BASE_URL="https://simcaq.c3sl.ufpr.br/api/v1/"
+```
+Set 
\ No newline at end of file
-- 
GitLab