From 8b31eba01d047723fd5a27f10a98811c7516fa88 Mon Sep 17 00:00:00 2001
From: Shahrad Elahi <shahradq@gmail.com>
Date: Fri, 31 May 2024 19:08:52 +0330
Subject: [PATCH] pretty docs

---
 README.md | 41 +++++++++++++++++++++++++----------------
 1 file changed, 25 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 1e8e5fb..f93236b 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,32 @@
-# storage-box
+<h1 align="center">
+<sup>StorageBox</sup>
+<br>
+<a href="https://github.com/shahradelahi/storage-box/actions/workflows/ci.yml"><img src="https://github.com/shahradelahi/storage-box/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+<a href="https://www.npmjs.com/package/storage-box"><img src="https://img.shields.io/npm/v/storage-box" alt="npm"></a>
+<a href="https://packagephobia.now.sh/result?p=storage-box"><img src="https://packagephobia.now.sh/badge?p=storage-box" alt="npm bundle size"></a>
+<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green.svg" alt="MIT"></a>
+</h1>
 
-[![CI](https://github.com/shahradelahi/storage-box/actions/workflows/ci.yml/badge.svg)](https://github.com/shahradelahi/storage-box/actions/workflows/ci.yml)
-[![npm](https://img.shields.io/npm/v/storage-box)](https://www.npmjs.com/package/storage-box)
-[![npm bundle size](https://packagephobia.now.sh/badge?p=storage-box)](https://packagephobia.now.sh/result?p=storage-box)
-[![MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+_storage-box_ is a JavaScript library designed for the purpose of storing data in various structures across multiple
+storage systems. The primary goal of this library is to offer a straightforward and effective method for data storage.
 
-> Storing data in various structures across multiple storage systems.
+---
 
-### Notable Features
+## 👀 Features
 
-- Easy to use API
+- Simple API
 - Support for **Node.js**, **Bun** and the **browser**
-- Support for multiple storage types (memory, file, local storage, etc.)
-- Multiple data structures (literals, hashes, lists, etc.)
+- Support for multiple storage types (Memory, File, Browser-storage, etc.)
+- Multiple data structures (Literals, Hashes, Lists, etc.)
 - Time-based key expiration
 
-### Installation
+## ⚙️ Installation
 
 ```bash
 npm i storage-box
 ```
 
-### 📖 Usage
+## 📖 Usage
 
 ```typescript
 import { Client } from 'storage-box';
@@ -41,22 +46,26 @@ setTimeout(() => {
 }, 3e3);
 ```
 
-### 📦 Storage Types
+## 📦 Storage Types
 
 - Memory ([Docs](docs/driver-memory.md)) (default)
 - File-based (Fs) ([Docs](docs/driver-fs.md))
 - Local/Session Storage ([Docs](docs/driver-browser.md))
 
-### 📚 Documentation
+## 📚 Documentation
 
 For all configuration options, please see [the API docs](https://paka.dev/npm/storage-box/api).
 
-### 🤝 Contributing
+## 🤝 Contributing
 
 You can contribute to this project by opening an issue or a pull request
 on [GitHub](https://github.com/shahradelahi/storage-box). Feel free to contribute, we care about your ideas and
 suggestions.
 
-### License
+## Project Stats
+
+![Alt](https://repobeats.axiom.co/api/embed/e1a9aca6e883cd81bba207c4edb9713c24796edd.svg 'Repobeats analytics image')
+
+## License
 
 [MIT](/LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi)