diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..c200cb5 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,206 @@ +

+fe-pilot Logo +

+

A React UI library for Advance Web 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. + +## Table of contents +1. 🚀 [Features](#features) +2. 📦 [Installation](#installation) +3. 💻 [Usage](#usage) +4. 📚 [Online Editor Templates](#online-editor-templates) +5. 🔦 [Plug and Play](#plug-and-play-around-the-features-and-component) +6. 📝 [Contributing](#contributing) +7. ✨ [Contributors](#contributors) +8. ⚖️ [License](#license) + +## 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`, `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 + +###### 1. Package Manager yarn +```sh +yarn add fe-pilot +``` +###### 2. Package Manager npm +```sh +npm i fe-pilot --save +``` +###### 3. Package Manager pnpm +```sh +pnpm add fe-pilot +``` +###### 4. Package Manager bun +```sh +bun add fe-pilot +``` + +## Usage + +#### 1. Use fe-pilot in your application +```js +import Share from 'fe-pilot/Share'; + + +``` +> [!Note] +>
+> See the list of components +> +> ### +> 1. AutoFillOtp            :white_check_mark:   [Implementation & Structure](./__app/component/AutoFillOtp/README.md) +> 2. CopyToClipboard :white_check_mark:   [Implementation & Structure](./__app/component/CopyToClipboard/README.md) +> 3. LiveLocation         :white_check_mark:   [Implementation & Structure](./__app/component/LiveLocation/README.md) +> 4. LocateMe              :white_check_mark:   [Implementation & Structure](./__app/component/LocateMe/README.md) +> 5. PhoneBook           :white_check_mark:   [Implementation & Structure](./__app/component/PhoneBook/README.md) +> 6. Scanner                 :white_check_mark:   [Implementation & Structure](./__app/component/Scanner/README.md) +> 7. Share                     :white_check_mark:   [Implementation & Structure](./__app/component/Share/README.md) +> 8. TextToSpeech       :white_check_mark:   [Implementation & Structure](./__app/component/TextToSpeech/README.md) +> 9. VoiceRecognition :white_check_mark:   [Implementation & Structure](./__app/component/VoiceRecognition/README.md) +>
+ +## Online Editor Templates + +#### 1. CodeSandbox +- JavaScript Starter: https://codesandbox.io/p/sandbox/fe-pilot-js-6jpxdq + + + +#### 2. Stackblitz +- JavaScript Starter: https://stackblitz.com/edit/fe-pilot?file=src%2FApp.jsx + + + +
+ +## Plug and Play around the features and component + +1. https://6jpxdq.csb.app/ +2. https://fepilot-qhym--5173--810981ba.local-credentialless.webcontainer.io/ +
+ +> [!IMPORTANT] +> Play around links have better support in your actual Mobile Device. + +
+ +## 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 +
+

+
+

+ + Hardik Jain +
+ Hardik Jain +
+

+
+

+ + Alok Dubey +
+ Alok Dubey +
+

+
+

+ + Ravi Verma +
+ Ravi Verma +
+

+
+

+ + Semantic Release Bot +
+ Semantic Release Bot +
+

+
+

+ + Ghanshyam KD +
+ Ghanshyam KD +
+

+
+

+ + Fossa Bot +
+ Fossa Bot +
+

+
+ +> [!TIP] +> After the contribution, Contributor name will be shown in the List. + + + +## License + +MIT © [Himanshu Gupta](https://github.com/opensrc0) diff --git a/README.md b/README.md index c200cb5..21f9d55 100644 --- a/README.md +++ b/README.md @@ -83,14 +83,14 @@ import Share from 'fe-pilot/Share'; > See the list of components > > ### -> 1. AutoFillOtp            :white_check_mark:   [Implementation & Structure](./__app/component/AutoFillOtp/README.md) +> 1. AutoFillOtp              :white_check_mark:   [Implementation & Structure](./__app/component/AutoFillOtp/README.md) > 2. CopyToClipboard :white_check_mark:   [Implementation & Structure](./__app/component/CopyToClipboard/README.md) -> 3. LiveLocation         :white_check_mark:   [Implementation & Structure](./__app/component/LiveLocation/README.md) -> 4. LocateMe              :white_check_mark:   [Implementation & Structure](./__app/component/LocateMe/README.md) -> 5. PhoneBook           :white_check_mark:   [Implementation & Structure](./__app/component/PhoneBook/README.md) -> 6. Scanner                 :white_check_mark:   [Implementation & Structure](./__app/component/Scanner/README.md) -> 7. Share                     :white_check_mark:   [Implementation & Structure](./__app/component/Share/README.md) -> 8. TextToSpeech       :white_check_mark:   [Implementation & Structure](./__app/component/TextToSpeech/README.md) +> 3. LiveLocation           :white_check_mark:   [Implementation & Structure](./__app/component/LiveLocation/README.md) +> 4. LocateMe                 :white_check_mark:   [Implementation & Structure](./__app/component/LocateMe/README.md) +> 5. PhoneBook             :white_check_mark:   [Implementation & Structure](./__app/component/PhoneBook/README.md) +> 6. Scanner                    :white_check_mark:   [Implementation & Structure](./__app/component/Scanner/README.md) +> 7. Share                         :white_check_mark:   [Implementation & Structure](./__app/component/Share/README.md) +> 8. TextToSpeech        :white_check_mark:   [Implementation & Structure](./__app/component/TextToSpeech/README.md) > 9. VoiceRecognition :white_check_mark:   [Implementation & Structure](./__app/component/VoiceRecognition/README.md) > @@ -114,11 +114,6 @@ import Share from 'fe-pilot/Share'; 2. https://fepilot-qhym--5173--810981ba.local-credentialless.webcontainer.io/
-> [!IMPORTANT] -> Play around links have better support in your actual Mobile Device. - -
- ## 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. @@ -196,10 +191,6 @@ Thanks goes to these wonderful people -> [!TIP] -> After the contribution, Contributor name will be shown in the List. - - ## License