Skip to content

Commit

Permalink
fix(readme.md): updated readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
opensrc0 committed Feb 27, 2024
1 parent da85443 commit daeed5b
Show file tree
Hide file tree
Showing 9 changed files with 182 additions and 7 deletions.
2 changes: 0 additions & 2 deletions .github/AUTHORS
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Himanshu Gupta <opensrc.0@gmail.com>
Alok Dubey <alokje2013@gmail.com>
Ravi Verma <rkverma393@gmail.com>
Ghanshyam KD <gk.dobariya@gmail.com>
Hardik Jain <29hdkjain@gmail.com>
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at <%= email %>. All
reported by contacting the project team at opensrc0@gmail.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
3 changes: 2 additions & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ major version.

| Version | Supported |
| ------- | ------------------ |
| 1.0.x | :white_check_mark: |
| 2.0.x | :white_check_mark: |
| < 2.0 | :x: |

## Reporting a Vulnerability

Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
* **package.json:** changed command in package.json ([8e5d7fa](https://github.com/opensrc0/fe-pilot/commit/8e5d7fa42c928f96067c6951d876f0b73e91bba2))
* **resolved conflicts:** conflicts resolved ([d2f97d4](https://github.com/opensrc0/fe-pilot/commit/d2f97d489c7747fb95af023b99977ee19c0008d6))


## [1.0.1](https://github.com/opensrc0/fe-pilot/compare/v1.0.0...v1.0.1) (2024-2-26)


Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Himanshu Gupta

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
149 changes: 147 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,148 @@
<h2 align="center">FE-Pilot </h2>
<h2 align="center">A React UI library provide latest built in web feature </h2>
<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.

## Table of contents
1. 🚀 [Features](#features)
2. 📦 [Installation](#installation)
3. 💻 [Usage](#usage)
4. 📚 [Online Editor Templates](#online-editor-templates)
5. 📝 [Contributing](#contributing)
6.[Contributors](#contributors)
7. ⚖️ [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`, `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)
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logol.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 10 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,16 @@
"react-components",
"ui-component",
"ui-library",
"web"
"web",
"advance-component",
"advance-feature",
"scanner",
"phonebook",
"voice",
"autofillotp",
"share",
"livelocationtracking",
"detectmylocation"
],
"config": {
"commitizen": {
Expand Down

0 comments on commit daeed5b

Please sign in to comment.