Skip to content

Commit

Permalink
Note on capacitor in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HarelM committed May 22, 2024
1 parent 1471bea commit 43486be
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
# Cordova Background Geolocation Plugin

[![npm](https://img.shields.io/npm/v/cordova-background-geolocation-plugin?style=flat-square)](https://www.npmjs.com/package/cordova-background-geolocation-plugin)
![npm bundle size](https://img.shields.io/bundlephobia/min/cordova-background-geolocation-plugin?style=flat-square)
![npm](https://img.shields.io/npm/dm/cordova-background-geolocation-plugin?style=flat-square)
![npm downloads](https://img.shields.io/npm/dm/cordova-background-geolocation-plugin?style=flat-square)

[![GitHub issues](https://img.shields.io/github/issues/HaylLtd/cordova-background-geolocation-plugin?style=flat-square)](https://github.com/HaylLtd/cordova-background-geolocation-plugin/issues)
[![GitHub stars](https://img.shields.io/github/stars/HaylLtd/cordova-background-geolocation-plugin?style=flat-square)](https://github.com/HaylLtd/cordova-background-geolocation-plugin/stargazers)
![GitHub last commit](https://img.shields.io/github/last-commit/HaylLtd/cordova-background-geolocation-plugin?style=flat-square)

![cordova](https://img.shields.io/badge/cordova-ios%20%7C%20android-blue?style=flat-square)

## Introduction

*Cross-platform geolocation for Cordova with battery-saving "circular region monitoring" and "stop detection"*
*Cross-platform geolocation for Cordova and Capacitor with battery-saving "circular region monitoring" and "stop detection"*

This plugin can be used for geolocation when the app is running in the foreground or background. It is more battery and data efficient than html5 geolocation or cordova-geolocation plugin. It can be used side by side with other geolocation providers (eg. html5 navigator.geolocation).
This plugin can be used for geolocation when the app is running in the foreground or background. It is more battery and data efficient than html5 geolocation. It can be used side by side with other geolocation providers (eg. html5 navigator.geolocation).

This project is based on [@mauron85/cordova-plugin-background-geolocation](https://github.com/mauron85/cordova-plugin-background-geolocation), which in turn was based on the original [cordova-background-geolocation plugin](https://github.com/christocracy/cordova-plugin-background-geolocation) by [christocracy](https://github.com/christocracy). Hayl Ltd have taken on responsibility for hosting it and will be maintaining it and merging PRs from the community. If you have any fixes, features or updates that you would like included, please do raise a PR or issue on the GitHub repository.

Expand All @@ -30,6 +27,8 @@ The NPM package can be found at [cordova-background-geolocation-plugin](https://

**Note:** for non AndroidX project please use version 1.x of this plugin. Version 2.x and on will support AndroidX.

**Note:** this plugin can be installed on a Capacitor project and it is tested to be working as expected, some configuration may need to be done differently than below according to how Capacitor configuration is implemented.

```bash
cordova plugin add cordova-background-geolocation-plugin
```
Expand Down

0 comments on commit 43486be

Please sign in to comment.