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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Freshworks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

package/dist/README.md

@@ -0,0 +1,86 @@
+<h1 align="center">Freemium Ui</h1>
+
+## [DEMO](https://freemium-ui.netlify.app)
+
+[React](https://reactjs.org/) based light weight ui components based on [Styled Components](https://styled-components.com/)
+
+## Installation
+
+Peer Dependencies to be installed
+
+```
+npm install styled-components
+```
+
+Install the package
+
+```
+npm install freemium-ui
+```
+
+Please note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.
+
+## Usage
+
+Here is a quick example to get you started, **it's all you need**:
+
+```jsx
+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>;
+}
+
+ReactDOM.render(<App />, document.querySelector('#app'));
+```
+
+## Contribution
+
+Install Dependencies
+
+```
+npm install
+```
+
+Start the app using storybook
+
+```
+npm run storybook
+```
+
+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
+
+```
+npm login --registry=https://registry.npmjs.org/
+```
+
+Publish the package to npm
+
+```
+npm publish
+```