From 4c534b65f0346409f7f95433a4d9c7b965833560 Mon Sep 17 00:00:00 2001
From: Joanna Fourquet <joanna.fourquet@inra.fr>
Date: Mon, 4 Feb 2019 17:19:54 +0100
Subject: [PATCH] Update README.md #5

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 698f6344..9d63c340 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,31 @@
-# metagWGS
+# **metagWGS**
 
+# Introduction
+
+**metagWGS** is a Nextflow bioinformatics analysis pipeline used for Metagenomic Shotgun Sequencing data.
+
+The workflow processes raw data from FastQ inputs, control quality data (FastQC and multiQC), trim adapters sequences and clean reads (Cutadapt, Sickle), suppress contaminants (BWA mem)... See the output documentation for more details of the results.
+
+The pipeline is built using Nextflow, a bioinformatics workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with singularity containers making installation trivial and results highly reproducible.
+
+## Installation
+
+## Prerequisite
+
+* Cutadapt >= v1.15
+* Sickle v1.33
+* FastQC >= v0.11.1
+* MultiQC 
+* BWA mem
+* Python >= v3
+
+## Usage
+
+```python
+nextflow run main.nf
+```
+
+## Contributing
+
+
+## License
-- 
GitLab