-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(readme.md): created 2 readme.md, onde for github one for npm
- Loading branch information
Showing
2 changed files
with
213 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| <p align="center"> | ||
| <img src="https://github.com/opensrc0/fe-pilot/blob/develop/logo.png" alt="fe-pilot Logo" align="center" width="30%" style="width: 30%;"> | ||
| </p> | ||
| <h2 align="center">A React UI library for Advance Web Features 👨✈️ </h2> | ||
| <br /> | ||
| <h3 > | ||
| <p align="center" class="tasklist-issue-content"> | ||
| <a href="https://www.npmjs.com/package/fe-pilot"> | ||
| <img alt="Minified Size" src="https://badgen.net/bundlephobia/minzip/fe-pilot?color=cyan"/> | ||
| </a> | ||
| <a href="https://react.dev/reference/react"> | ||
| <img alt="React Version" src="https://img.shields.io/badge/react-18.2.0-%23f1e05a?logo=React"/> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/fe-pilot"> | ||
| <img alt="NPM Downloads" src="https://img.shields.io/npm/dw/fe-pilot?label=Downloads&logo=npm"/> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/fe-pilot/v/latest"> | ||
| <img alt="Latest Release" src="https://badgen.net/github/release/opensrc0/fe-pilot?icon=github&color=pink"/> | ||
| </a> | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://github.com/opensrc0/fe-pilot/stargazers"> | ||
| <img alt="Github Stars" src="https://badgen.net/github/stars/opensrc0/fe-pilot?icon=github&color=purple"/> | ||
| </a> | ||
| <a href="https://github.com/opensrc0/fe-pilot?tab=MIT-1-ov-file"> | ||
| <img alt="MIT License" src="https://badgen.net/static/license/MIT/orange"/> | ||
| </a> | ||
| </p> | ||
| </h3> | ||
| <br /> | ||
|
|
||
| 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'; | ||
|
|
||
| <Share | ||
| name={'fe-pilot'} | ||
| title={'A React library for advance web features'} | ||
| url={'https://www.npmjs.com/package/fe-pilot'} | ||
| /> | ||
| ``` | ||
| > [!Note] | ||
| > <details> | ||
| > <summary>See the list of components</summary> | ||
| > | ||
| > ### | ||
| > 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) | ||
| ></details> | ||
| ## Online Editor Templates | ||
|
|
||
| #### 1. CodeSandbox | ||
| - JavaScript Starter: https://codesandbox.io/p/sandbox/fe-pilot-js-6jpxdq | ||
| <!-- - TypeScript Starter: WIP --> | ||
| <!-- - NextJS TypeScript Starter: WIP --> | ||
|
|
||
| #### 2. Stackblitz | ||
| - JavaScript Starter: https://stackblitz.com/edit/fe-pilot?file=src%2FApp.jsx | ||
| <!-- - TypeScript Starter: WIP --> | ||
| <!-- - NextJS TypeScript Starter: WIP --> | ||
|
|
||
| <br /> | ||
|
|
||
| ## Plug and Play around the features and component | ||
|
|
||
| 1. https://6jpxdq.csb.app/ | ||
| 2. https://fepilot-qhym--5173--810981ba.local-credentialless.webcontainer.io/ | ||
| <br /> | ||
|
|
||
| > [!IMPORTANT] | ||
| > Play around links have better support in your actual Mobile Device. | ||
| <br /> | ||
|
|
||
| ## 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 | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"> | ||
| <p> | ||
| <a href="https://github.com/opensrc0"> | ||
| <img src="https://avatars.githubusercontent.com/u/6891544?s=400&v=4" width="64px;" alt="Himanshu Gupta" /> | ||
| <br /> | ||
| <sub><b>Himanshu Gupta</b></sub> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| <td align="center" valign="top" width="14.28%"> | ||
| <p> | ||
| <a target="_blank" href="https://github.com/hardikjain29"> | ||
| <img src="https://avatars.githubusercontent.com/u/13768932?v=4" width="64px;" alt="Hardik Jain" /> | ||
| <br /> | ||
| <sub><b>Hardik Jain</b></sub> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| <td align="center" valign="top" width="14.28%"> | ||
| <p> | ||
| <a href="https://github.com/Alok30"> | ||
| <img src="https://avatars.githubusercontent.com/u/36290248?s=64&v=4" width="64px;" alt="Alok Dubey" /> | ||
| <br /> | ||
| <sub><b>Alok Dubey</b></sub> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| <td align="center" valign="top" width="14.28%"> | ||
| <p> | ||
| <a href="https://github.com/Ravi-Chef"> | ||
| <img src="https://avatars.githubusercontent.com/u/31059087?v=4" width="64px;" alt="Ravi Verma" /> | ||
| <br /> | ||
| <sub><b>Ravi Verma</b></sub> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| <td align="center" valign="top" width="14.28%"> | ||
| <p> | ||
| <a target="_blank" href="https://github.com/semantic-release-bot"> | ||
| <img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="64px;" alt="Semantic Release Bot" /> | ||
| <br /> | ||
| <sub><b>Semantic Release Bot</b></sub> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| <td align="center" valign="top" width="14.28%"> | ||
| <p> | ||
| <a target="_blank" href="https://github.com/Ghanshyam-K-Dobariya"> | ||
| <img src="https://avatars.githubusercontent.com/u/5426993?s=400" width="64px;" alt="Ghanshyam KD" /> | ||
| <br /> | ||
| <sub><b>Ghanshyam KD</b></sub> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| <td align="center" valign="top" width="14.28%"> | ||
| <p> | ||
| <a target="_blank" href="https://github.com/fossabot"> | ||
| <img src="https://avatars.githubusercontent.com/u/29791463?v=4" width="64px;" alt="Fossa Bot" /> | ||
| <br /> | ||
| <sub><b>Fossa Bot</b></sub> | ||
| </a> | ||
| </p> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| > [!TIP] | ||
| > After the contribution, Contributor name will be shown in the List. | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| MIT © [Himanshu Gupta](https://github.com/opensrc0) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters