Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Igor M committed Sep 10, 2022
2 parents b141824 + d16fc6a commit 3c8f7aa
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## At a Glance

**ZipMonster** is a library that simplifies work with zip codes and addresses in the United States.
**ZipMonster** is a library that simplifies work with zip codes and addresses in the United States. This solution is a reliable replacement for paid APIs that you can find on the Internet.

## How to Get Started

Expand All @@ -36,7 +36,17 @@ import ZipMonster from '@russo-programmisto/zip-monster'

## Requirements

Basic knowledge of TypeScript and NPM.
It's strongly recommended to add `NODE_OPTIONS` flag to your `.env` file:

```
NODE_OPTIONS=--max-old-space-size=<AVAILABLE RAM SIZE IN MB>
```

For example, if you have 2GB RAM:

```
NODE_OPTIONS=--max-old-space-size=2048
```

## Usage

Expand Down

0 comments on commit 3c8f7aa

Please sign in to comment.