Skip to content

Commit

Permalink
chore: update readme and package name for release
Browse files Browse the repository at this point in the history
  • Loading branch information
genesisxyz committed Mar 14, 2024
1 parent c12dbdf commit fa72519
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 12 deletions.
51 changes: 40 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,49 @@
# react-native-package-installer

Package installer
<h1 align="center">
react-native-package-installer
</h1>

<h4 align="center">Install any package on Android with a single command</h4>

<p align="center">
<a href="https://badge.fury.io/js/@dev/react-native-package-installer">
<img src="https://badge.fury.io/js/@dev/react-native-package-installer.svg"
alt="npm">
</a>
<a href="https://saythanks.io/to/[email protected]">
<img src="https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg">
</a>
<a href="https://www.paypal.me/genesisxyz">
<img src="https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&amp;style=flat">
</a>
</p>

<p align="center">
<a href="#key-features">Key Features</a> •
<a href="#installation">How To Use</a> •
<a href="#how-to-use">How To Use</a> •
<a href="#license">License</a>
</p>

<div align="center">
<img src="readme.gif" alt="screenshot">
</div>

## Key Features

- Install any package on Android with a single line of code
- Silent install with admin privileges

## Installation

```sh
npm install react-native-package-installer
npm install @gen/react-native-package-installer
```

## Usage
## How To Use

### Android

To install silently the app, you need admin priviledges
To install the app silently, you need admin priviledges

To enable admin you need to run:

Expand Down Expand Up @@ -40,14 +71,12 @@ import { install } from 'react-native-package-installer';
await install('/path/to/apk');
```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
> [genesisxyz.dev](https://www.genesisxyz.dev) &nbsp;&middot;&nbsp;
> GitHub [@genesisxyz](https://github.com/genesisxyz) &nbsp;&middot;&nbsp;
> Twitter [@thedummyxyz](https://twitter.com/thedummyxyz)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "react-native-package-installer",
"name": "@gen/react-native-package-installer",
"version": "0.1.0",
"description": "test",
"main": "lib/commonjs/index",
Expand Down
Binary file added readme.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa72519

Please sign in to comment.