From b82dc6a366ee47a857ab786f2ac5440ed9006fe6 Mon Sep 17 00:00:00 2001
From: basti <sb@pus.de>
Date: Tue, 4 Dec 2018 11:41:34 +0100
Subject: [PATCH] Readme aktualisier

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 0c7605c..211ae91 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,17 @@
 # masterJLU2018
+
+Tool for automaticly retrieving Regulatory Features based on [Ensembl Regulatory Build](http://www.ensembl.org/info/genome/funcgen/regulatory_build.html) 
+and [UCSC-Table-Browser](https://genome.ucsc.edu/cgi-bin/hgTables). Generating a GTF-File with Activity Data for a customisable number of tissue- and celltype categories.
+
+## Usage
+
+python3 ./RegGTFExtractor.py organism [--tissue]
+
+- organism = Source organism (currently supported homo_sapiens and mus_musculus)
+- --tissue[] = optional Parameter: List of Tissues based on ./config/celltypes_organism.json Filters the output by activity
+
+
+## Dependencies
+
+- Linux 64-bit
+- Python3 or newer
\ No newline at end of file