From ba5038fddec7f421b25ba8c771c7c7c3321011a0 Mon Sep 17 00:00:00 2001
From: George Rosenberger <gr2578@cumc.columbia.edu>
Date: Tue, 28 May 2019 13:22:41 +0200
Subject: [PATCH] [FEATURE] Updated Readme

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 40 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 308bf79..a821957 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
-EasyPQP: Simple library generation for OpenSWATH using MSFragger & PyProphet
+EasyPQP: Simple library generation for OpenSWATH
+================================================
+
+EasyPQP is a Python package that provides simplified and fast peptide query parameter generation for OpenSWATH. It can process input from MSFragger or other database search engines in pepXML format. Statistical validation can be conducted either using PyProphet or PeptideProphet/iProphet. Retention times are calibrated using an internal or external standard. In addition to a cumulative library, run-specific libraries are generated for non-linear RT alignment in OpenSWATH.
+
+Installation
 ============
 
+We strongly advice to install EasyPQP in a Python [*virtualenv*](https://virtualenv.pypa.io/en/stable/). EasyPQP is compatible with Python 3.
+
+Install the development version of *easypqp* from GitHub:
+
+````
+    $ pip install git+https://github.com/grosenberger/easypqp.git@master
+````
+
+Running EasyPQP
+===============
+
+*EasyPQP* is not only a Python package, but also a command line tool:
+
+````
+   $ easypqp --help
+````
+
+or:
+
+````
+   $ easypqp convert --help
+   $ easypqp library --help
+````
+
+Docker
+======
+
+EasyPQP is also available from Docker (automated builds):
+
+Pull the development version of *easypqp* from DockerHub (synced with GitHub):
+
+````
+    $ docker pull grosenberger/easypqp:latest
+````