Skip to content

Commit

Permalink
clarify purpose of battery-status package
Browse files Browse the repository at this point in the history
  • Loading branch information
tido64 committed Sep 26, 2023
1 parent b518df1 commit 3618b4a
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions incubator/@react-native-webapis/battery-status/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@
[Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery_Status_API)
for React Native.

## Motivation

This is a prototype for the
[React Native WebAPIs RFC](https://github.com/microsoft/rnx-kit/pull/2504)
> **Note**
>
> This is purely a prototype for the
> [React Native WebAPIs RFC](https://github.com/microsoft/rnx-kit/pull/2504). It
> currently does not implement the Battery Status API to spec, e.g. it's missing
> events and its properties are not updated live. Rather, its purpose is to show
> that it's possible to have a native module polyfill a web API, enabling direct
> use of previously web-only code in a React Native app.
## Installation

Expand Down

0 comments on commit 3618b4a

Please sign in to comment.