Updated with instructions on how to install.

This commit is contained in:
Nathan Kerr 2019-07-30 19:19:44 +00:00
parent f0c2a98d72
commit 5bf63c3757

View File

@ -1,7 +1,4 @@
<p align="left">
<b><a href="https://github.com/katzer/cordova-plugin-background-mode/tree/example">SAMPLE APP</a> :point_right:</b>
</p>
This is a fork of [a great plugin by katzer](https://github.com/katzer/cordova-plugin-background-mode/). It aims to keep up-to-date with Android changes while also providing more features.
Cordova Background Plugin [![npm version](https://badge.fury.io/js/cordova-plugin-background-mode.svg)](http://badge.fury.io/js/cordova-plugin-background-mode) [![Build Status](https://travis-ci.org/katzer/cordova-plugin-background-mode.svg?branch=master)](https://travis-ci.org/katzer/cordova-plugin-background-mode) [![codebeat badge](https://codebeat.co/badges/49709283-b313-4ced-8630-f520baaec7b5)](https://codebeat.co/projects/github-com-katzer-cordova-plugin-background-mode)
=========================
@ -25,23 +22,11 @@ Use the plugin by your own risk!
## Installation
The plugin can be installed via [Cordova-CLI][CLI] and is publicly available on [NPM][npm].
The plugin can be installed via [Cordova-CLI][CLI] and will be publicly available on [NPM][npm] eventually.
Execute from the projects root folder:
$ cordova plugin add cordova-plugin-background-mode
Or install a specific version:
$ cordova plugin add de.appplant.cordova.plugin.background-mode@VERSION
Or install the latest head version:
$ cordova plugin add https://github.com/katzer/cordova-plugin-background-mode.git
Or install from local source:
$ cordova plugin add cordova-plugin-background-mode --searchpath <path>
$ cordova plugin add https://bitbucket.org/TheBosZ/cordova-plugin-run-in-background
## Usage