diff --git a/README.md b/README.md index b5c7811..a482a07 100644 --- a/README.md +++ b/README.md @@ -1,138 +1,4 @@

fe-pilot Logo

-

A React UI library for Advance JS Features 👨‍✈️

-
-

- - Minified Size - - - React Version - - - NPM Downloads - - - Latest Release - -

-

- - Github Stars - - - MIT License - -

-
- -A React UI library for Advance Web Features that streamlines the development of modern web applications and websites. The library offers component like scanner, voice search, autofill otp, phonebook, share and many more for a small/medium/large size web based applications. Fe-Pilot is a easy to use, light weighted, fully mobile APP like features in web. - -## Features -- **Web/Mobile Support:** fe-pilot will be helpfull in Large/Mid/Small size of web based applications. -- **Ease of Use:** fe-pilot contains a set of components like `Scanner`, `PhoneBook`, `Voice Search`, `Share`, `Contact List`, `Live Location Tracking`, `Current Location` that are easy to plug and play. -- **Scalable & Maintainable:** fe-pilot components are built on top of a React for better scalable, maintainable component. - -## Installation -Install `fe-pilot` package using any package manager - -```sh -# with Yarn -$ yarn add fe-pilot - -# with npm -$ npm i fe-pilot --save - -# with pnpm -$ pnpm add fe-pilot - -# with Bun -$ bun add fe-pilot -``` - -## Usage -#### 1. Use fe-pilot in your application -```js -import Scanner from 'fe-pilot/Scanner'; - - -``` - - -## Online Editor Templates - -#### 1. CodeSandbox -- JavaScript Starter: https://codesandbox.io/p/devbox/fe-pilot-js-6q2vcg - - - -#### 2. Stackblitz -- JavaScript Starter: https://stackblitz.com/edit/fe-pilot-js-b6mri2 - - - - -## Contributing - -Feel like contributing? Most welcome! -[Setup locally](./.github/SETUP.md) to get fe-pilot working on your local machine and [guide lines](./.github/CONTRIBUTING.md) to contribute in fe-pilot. - -## Contributors - -Thanks goes to these wonderful people - - - - - - - - - - - - - -
- - Himanshu Gupta -
- Himanshu Gupta -
-
-
- - Ghanshyam KD -
- Ghanshyam KD -
-
-
- - Hardik Jain -
- Hardik Jain -
-
-
- - Semantic Release Bot -
- Semantic Release Bot -
-
-
- - Fossa Bot -
- Fossa Bot -
-
-
- - - -## License - -MIT © [Himanshu Gupta](https://github.com/opensrc0) +

A React UI library for Advance JS Features 👨‍✈️

\ No newline at end of file