Skip to content

Commit

Permalink
Document need of deepmerge for future reference
Browse files Browse the repository at this point in the history
  • Loading branch information
kilemensi committed Aug 1, 2024
1 parent cf03c82 commit 4584794
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
15 changes: 15 additions & 0 deletions packages/hurumap-core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# @hurumap/core

### Getting started

To run `@hurumap/core` test:

```sh
pnpm test
```

### Development

#### Important

While `@mui/utils` provides a [`deepmerge`](https://github.com/mui/material-ui/blob/next/packages/mui-utils/src/deepmerge/deepmerge.ts) function, this function doesn't support merging arrays. For this reason, `@hurumap/core` opts to use [`deepmerge`](https://github.com/TehShrike/deepmerge) package since HURUmap makes have use of arrays of data to render charts (using Vega library).
9 changes: 9 additions & 0 deletions packages/hurumap-next/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# @hurumap/next

### Getting started

To run `@hurumap/next` test:

```sh
pnpm test
```

0 comments on commit 4584794

Please sign in to comment.