freemium-ui 2.0.0-beta.7 → 2.0.0-beta.71

package/README.md

@@ -15,7 +15,7 @@ npm install styled-components
 Install the package
 
 ```
-npm install @freshdesk/freemium-ui
+npm install freemium-ui
 ```
 
 Please note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.
@@ -28,6 +28,7 @@ Here is a quick example to get you started, **it's all you need**:
 import React from 'react';
 import ReactDOM from 'react-dom';
 import { Button } from 'freemium-ui';
+// import { Button } from 'freemium-ui/Button';
 
 function App() {
   return <Button>Freemium Button</Button>;
@@ -56,6 +57,20 @@ Build Freemium Ui Core Components
 npm run build
 ```
 
+JavaScript heap out of memory could lead to build failure. Check the [official docs](https://rollupjs.org/troubleshooting/#error-javascript-heap-out-of-memory). Or execute any of the required below config
+
+```
+export NODE_OPTIONS="--max-old-space-size=8192"
+export NODE_OPTIONS="--max-old-space-size=12288"
+export NODE_OPTIONS="--max-old-space-size=16384"
+```
+
+To check the heap size in MB
+
+```
+node -e 'console.log(v8.getHeapStatistics().heap_size_limit/(1024*1024))'
+```
+
 Generate a PAT with `admin:org`, `write:packages`, `read:packages`, `delete:packages`
 
 Authenticate to npm github package