freemium-ui 2.0.0-beta.0 → 2.0.0-beta.10

package/README.md

@@ -1,46 +1,86 @@
-# Getting Started with Create React App
+<h1 align="center">Freemium Ui</h1>
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## [DEMO](https://freemium-ui.netlify.app)
 
-## Available Scripts
+[React](https://reactjs.org/) based light weight ui components based on [Styled Components](https://styled-components.com/)
 
-In the project directory, you can run:
+## Installation
 
-### `npm start`
+Peer Dependencies to be installed
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+```
+npm install styled-components
+```
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+Install the package
 
-### `npm test`
+```
+npm install freemium-ui
+```
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+Please note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.
 
-### `npm run build`
+## Usage
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+Here is a quick example to get you started, **it's all you need**:
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+```jsx
+import React from 'react';
+import ReactDOM from 'react-dom';
+import { Button } from 'freemium-ui';
+// import { Button } from 'freemium-ui/Button';
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+function App() {
+  return <Button>Freemium Button</Button>;
+}
 
-### `npm run eject`
+ReactDOM.render(<App />, document.querySelector('#app'));
+```
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+## Contribution
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+Install Dependencies
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+```
+npm install
+```
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+Start the app using storybook
 
-## Learn More
+```
+npm run storybook
+```
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+Build Freemium Ui Core Components
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+```
+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
+```