Skip to content

Commit

Permalink
Update README.md with usage context and implementation warning
Browse files Browse the repository at this point in the history
  • Loading branch information
L422Y committed Nov 13, 2023
1 parent c68e67e commit 9f1e387
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ and integrates additional features such as caching, loadability, and automatic e
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).

## Features

MegaMap provides a suite of TypeScript classes for advanced key-value mapping, each offering unique capabilities:
Expand Down Expand Up @@ -42,6 +45,9 @@ npm install megamap

## Usage

In the examples below we are implementing things outside of state management, and in
a vue template directly. This is not recommended for production use, but is done here for the sake of simplicity.

For these examples, we will set up some fake data loader functions:

```typescript
Expand Down

0 comments on commit 9f1e387

Please sign in to comment.