From f4af32f33eeb97082b9d7b41c6c84025107bc41b Mon Sep 17 00:00:00 2001
From: ghost <localhost>
Date: Wed, 13 Dec 2023 23:44:54 +0200
Subject: [PATCH] update readme

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 96b20cc..c58ad3b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,45 @@
 # kevacoin-php
-Composer library for PHP applications 
+
+Composer library for PHP applications
+
+## Install
+
+`composer require clitor-is-protocol/kevacoin`
+
+## Examples
+
+To simply interact with Kevacoin API, use PHP library, e.g.
+
+`composer require kevachat/kevacoin`
+
+```
+
+// Connect kevacoin
+$client = new \Kevachat\Kevacoin\Client(
+    $protocol,
+    $host,
+    $port,
+    $username,
+    $password
+);
+
+// Get meta data by namespace
+if ($meta = $client->kevaGet($namespace, '_CLITOR_IS_'))
+{
+    // Init reader with meta data received
+    $reader = new \ClitorIsProtocol\Kevacoin\Reader(
+        $meta['value']
+    );
+
+    // Recommended to check the meta is valid
+    if ($reader->valid())
+    {
+        // Grab namespace records from blockchain
+        if ($pieces = $client->kevaFilter($namespace))
+        {
+          // Implement your app logic
+          echo $reader->data($pieces);
+        }
+    }
+}
+```
\ No newline at end of file