freemium-ui 2.0.0-beta.3 → 2.0.0-beta.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -15,7 +15,7 @@ npm install styled-components
15
15
  Install the package
16
16
 
17
17
  ```
18
- npm install @freshdesk/freemium-ui
18
+ npm install freemium-ui
19
19
  ```
20
20
 
21
21
  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**:
28
28
  import React from 'react';
29
29
  import ReactDOM from 'react-dom';
30
30
  import { Button } from 'freemium-ui';
31
+ // import { Button } from 'freemium-ui/Button';
31
32
 
32
33
  function App() {
33
34
  return <Button>Freemium Button</Button>;
@@ -56,6 +57,20 @@ Build Freemium Ui Core Components
56
57
  npm run build
57
58
  ```
58
59
 
60
+ 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
61
+
62
+ ```
63
+ export NODE_OPTIONS="--max-old-space-size=8192"
64
+ export NODE_OPTIONS="--max-old-space-size=12288"
65
+ export NODE_OPTIONS="--max-old-space-size=16384"
66
+ ```
67
+
68
+ To check the heap size in MB
69
+
70
+ ```
71
+ node -e 'console.log(v8.getHeapStatistics().heap_size_limit/(1024*1024))'
72
+ ```
73
+
59
74
  Generate a PAT with `admin:org`, `write:packages`, `read:packages`, `delete:packages`
60
75
 
61
76
  Authenticate to npm github package