From 6ac6b482872e45fc2ab7dde8cfd637591a44afca Mon Sep 17 00:00:00 2001
From: Viktor Matanski <vmatanski@localhost.localdomain>
Date: Wed, 31 Oct 2018 11:49:12 +0200
Subject: [PATCH] added readme

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 574a7f2..6fd02ba 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
-# key-storage-agent
\ No newline at end of file
+# Key Storage Agent
+
+1.  [Introduction](#introduction)
+1.  [Setup](#setup)
+1.  [License](#license)
+
+# Introduction 
+
+This agent is responsible for storing public and private keys used in the system and also for generating key pairs.
+
+It uses the Data Storage service for storing and updating the keys.
+
+It contains the following methods:
+*  GetKey
+*  SetKey
+*  ReserveKeyUUID
+*  Revoke
+*  GenerateKeyPair
+
+# Setup
+
+### Installation
+
+How to run:
+
+```
+$ cd $GOPATH/src/code.vereign.com/code/key-storage-agent 
+$ make all
+$ ./run.sh
+```
+
+# License
+
+This project is licensed under the AGPL License - see the [LICENSE](LICENSE) file for details.
\ No newline at end of file
-- 
GitLab