Skip to content

Commit

Permalink
docs: Update README with project description and example header
Browse files Browse the repository at this point in the history
  • Loading branch information
L422Y committed Nov 10, 2024
2 parents 66c2a00 + 6f2d7b9 commit fdad7a2
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# 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
ideal for sophisticated mapping solutions where enhanced control over data storage and retrieval is needed.

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'
Expand Down

0 comments on commit fdad7a2

Please sign in to comment.