-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update readme and package name for release
- Loading branch information
1 parent
c12dbdf
commit fa72519
Showing
3 changed files
with
41 additions
and
12 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 |
---|---|---|
@@ -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&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: | ||
|
||
|
@@ -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) · | ||
> GitHub [@genesisxyz](https://github.com/genesisxyz) · | ||
> Twitter [@thedummyxyz](https://twitter.com/thedummyxyz) |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.