freemium-ui 1.0.335 → 2.0.0-beta.0

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run check
+

package/README.md

@@ -1,71 +1,46 @@
-<h1 align="center">Freemium Ui</h1>
+# Getting Started with Create React App
 
-## [DEMO](https://freemium-ui.netlify.app)
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
-[React](https://reactjs.org/) based light weight ui components based on [Styled Components](https://styled-components.com/)
+## Available Scripts
 
-## Installation
+In the project directory, you can run:
 
-Peer Dependencies to be installed
+### `npm start`
 
-```
-npm install styled-components
-```
+Runs the app in the development mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-Install the package
+The page will reload if you make edits.\
+You will also see any lint errors in the console.
 
-```
-npm install @freshdesk/freemium-ui
-```
+### `npm test`
 
-Please note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.
+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.
 
-## Usage
+### `npm run build`
 
-Here is a quick example to get you started, **it's all you need**:
+Builds the app for production to the `build` folder.\
+It correctly bundles React in production mode and optimizes the build for the best performance.
 
-```jsx
-import React from 'react'
-import ReactDOM from 'react-dom'
-import {Button} from 'freemium-ui'
+The build is minified and the filenames include the hashes.\
+Your app is ready to be deployed!
 
-function App() {
-  return <Button>Freemium Button</Button>
-}
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
 
-ReactDOM.render(<App />, document.querySelector('#app'))
-```
+### `npm run eject`
 
-## Contribution
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
 
-Install Dependencies
+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.
 
-```
-npm install
-```
+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.
 
-Start the app using storybook
+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.
 
-```
-npm run storybook
-```
+## Learn More
 
-Build Freemium Ui Core Components
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
 
-```
-npm run build
-```
-
-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
-```
+To learn React, check out the [React documentation](https://reactjs.org/).