Skip to content

Commit

Permalink
fix(readme): readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
opensrc0 committed Feb 27, 2024
1 parent 3d5d784 commit f37d866
Showing 1 changed file with 1 addition and 135 deletions.
136 changes: 1 addition & 135 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,138 +1,4 @@
<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 JS Features 👨‍✈️ </h2>
<br />
<p align="center">
<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>
<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.

## 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';

<Scanner />
```


## Online Editor Templates

#### 1. CodeSandbox
- JavaScript Starter: https://codesandbox.io/p/devbox/fe-pilot-js-6q2vcg
<!-- - TypeScript Starter: WIP -->
<!-- - NextJS TypeScript Starter: WIP -->

#### 2. Stackblitz
- JavaScript Starter: https://stackblitz.com/edit/fe-pilot-js-b6mri2
<!-- - TypeScript Starter: WIP -->
<!-- - NextJS TypeScript Starter: WIP -->


## 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%">
<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>
<br />
</td>
<td align="center" valign="top" width="14.28%">
<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>
<br />
</td>
<td align="center" valign="top" width="14.28%">
<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>
<br />
</td>
<td align="center" valign="top" width="14.28%">
<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>
<br />
</td>
<td align="center" valign="top" width="14.28%">
<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>
<br />
</td>
</tr>
<tr>
</tr>
</tbody>
</table>



## License

MIT © [Himanshu Gupta](https://github.com/opensrc0)
<h2 align="center">A React UI library for Advance JS Features 👨‍✈️ </h2>

0 comments on commit f37d866

Please sign in to comment.