From 2bffed88336dec771758ed6fb2cc8f63a2a501c4 Mon Sep 17 00:00:00 2001
From: Aditya Manthramurthy <aditya.mmy@gmail.com>
Date: Fri, 10 Feb 2017 17:46:04 +0530
Subject: [PATCH] Update Readme

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 47 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b735917..599a751 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
-# minio-hs
-Minio Client SDK for Haskell
+# Minio Client SDK for Haskell
+
+This Minio Haskell Client SDK provides simple APIs to
+access [Minio](https://minio.io), AWS S3 or any S3-compatible object
+storage service.
+
+## Installation
+
+On a terminal, run the commands below. The
+Haskell [stack](https://docs.haskellstack.org/en/stable/README/) tool
+is required to be installed.
+
+``` shell
+
+# clone the repo.
+git clone https://github.com/donatello/minio-hs.git
+
+cd minio-hs/
+
+stack install
+
+```
+
+Tests can be run with:
+
+``` shell
+
+stack test
+
+```
+
+A section of the tests require a live Minio server, running on
+`http://localhost:9000`
+
+Documentation can be locally built with:
+
+
+``` shell
+
+stack haddock
+
+```
+
+## Contribution
+
+Your contributions are welcome, in the form of Pull Requests,
+questions on the issue tracker, and comments.