From ac5ab0a0c8ac4b4da832679ced3d035c79a9bf53 Mon Sep 17 00:00:00 2001
From: shuse2 <shus.toda@gmail.com>
Date: Wed, 20 Sep 2023 12:10:13 +0200
Subject: [PATCH 1/2] :seedling: Update readme

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9009af0..7b0c4ee 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,14 @@
 # @liskhq/lisk-db
 
+[![Build status](https://github.com/LiskHQ/lisk-db/actions/workflows/pr.yaml/badge.svg)](https://github.com/LiskHQ/lisk-db/actions/workflows/pr.yaml)
+![npm](https://img.shields.io/npm/v/@liskhq/lisk-db)
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/liskHQ/lisk-db)
+![GitHub repo size](https://img.shields.io/github/repo-size/liskhq/lisk-db)
+[![DeepScan grade](https://deepscan.io/api/teams/6759/projects/25497/branches/799572/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=6759&pid=25497&bid=799572)
+![GitHub issues](https://img.shields.io/github/issues-raw/liskhq/lisk-db)
+![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/liskhq/lisk-db)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+
 @liskhq/lisk-db is a database access implementation according to the Lisk protocol
 
 ## Installation
@@ -8,9 +17,25 @@
 $ npm install --save @liskhq/lisk-db
 ```
 
+## Get Started
+```js
+const { Database } = require('@liskhq/lisk-db');
+const db = new Database('./new-database');
+
+await db.set(Buffer.from([0]), Buffer.from('new item'));
+const value = await db.get(Buffer.from([0]));
+console.log(value);
+```
+
+## Dependencies
+The following dependencies need to be installed in order to build this repository.
+
+* [nodejs v18](https://nodejs.org)
+* [rust](https://www.rust-lang.org/)
+
 ## License
 
-Copyright 2016-2022 Lisk Foundation
+Copyright 2016-2023 Lisk Foundation
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

From 123d119aa8ef38883aa30675c30a4b96208d4dfe Mon Sep 17 00:00:00 2001
From: shuse2 <shuse2@users.noreply.github.com>
Date: Wed, 20 Sep 2023 13:17:30 +0200
Subject: [PATCH 2/2] Update README.md

Co-authored-by: Muhammad Talha <13951043+TalhaMaliktz@users.noreply.github.com>
---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7b0c4ee..1b61483 100644
--- a/README.md
+++ b/README.md
@@ -30,8 +30,8 @@ console.log(value);
 ## Dependencies
 The following dependencies need to be installed in order to build this repository.
 
-* [nodejs v18](https://nodejs.org)
-* [rust](https://www.rust-lang.org/)
+* [Node.js v18](https://nodejs.org)
+* [Rust](https://www.rust-lang.org/)
 
 ## License