From 6f2d7b990573dceb4720343ef366120c8e767e41 Mon Sep 17 00:00:00 2001 From: Larry Williamson Date: Sun, 10 Nov 2024 01:09:56 -0500 Subject: [PATCH] docs: Update README with project description and fix section title --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ff2c410..4b9bf58 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # MegaMap +> A TypeScript-first map implementation that handles loading, caching, searching, filtering, and reactivity. + [![wakatime](https://wakatime.com/badge/user/018b859f-13fa-41e2-9883-185549942dff/project/018bbdef-9ad5-44b2-a07f-56a02612b0e9.svg)](https://wakatime.com/badge/user/018b859f-13fa-41e2-9883-185549942dff/project/018bbdef-9ad5-44b2-a07f-56a02612b0e9) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![Build Status](https://github.com/l422y/megamap/actions/workflows/main.yml/badge.svg) + MegaMap is a TypeScript library designed for advanced key-value mapping. It extends the native JavaScript `Record` object and integrates additional features such as caching, loadability, and automatic expiry of entries. MegaMap is built upon two foundational classes, `LoadableMap` and `CachedLoadableMap`, each offering distinct capabilities. This library is @@ -11,11 +14,8 @@ ideal for sophisticated mapping solutions where enhanced control over data stora Ideally, this library is meant to be used in conjunction with a data store (e.g. a database, API, etc.), and/or state management solution, such as [pinia](https://github.com/vuejs/pinia). -# MegaMap - -A TypeScript-first map implementation that handles loading, caching, searching, filtering, and reactivity. -## Quick Start +## Quick Example ```typescript import { MegaMap, ReactiveMegaMap } from 'megamap'