Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
opensrc0 committed Mar 20, 2024
1 parent 51011b2 commit 671ea12
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,22 @@ A React UI library for Advance Web Features that streamlines the development of

## 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
###### 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
Expand Down Expand Up @@ -94,15 +97,17 @@ import Share from 'fe-pilot/Share';

1. https://6jpxdq.csb.app/
2. https://fepilot-qhym--5173--810981ba.local-credentialless.webcontainer.io/
<br />

> [!IMPORTANT]
> Play around links has 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
Expand Down Expand Up @@ -176,6 +181,9 @@ Thanks goes to these wonderful people
</tbody>
</table>

> [!TIP]
> After your contribution your name will be added in Contributors List.


## License
Expand Down

0 comments on commit 671ea12

Please sign in to comment.