Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Commit

Permalink
Update readme (#135)
Browse files Browse the repository at this point in the history
* 🌱 Update readme

* Update README.md

Co-authored-by: Muhammad Talha <13951043+TalhaMaliktz@users.noreply.github.com>
  • Loading branch information
shuse2 and TalhaMaliktz committed Sep 20, 2023
1 parent a9ce94b commit 8385468
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

* [Node.js 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.
Expand Down

0 comments on commit 8385468

Please sign in to comment.