Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 3.08 KB

README.md

File metadata and controls

76 lines (51 loc) · 3.08 KB
Raw

React Native Killswitch is a library built by Mirego that allows mobile developers to apply
runtime version-specific behaviors to their React Native application.



What is Killswitch?

Killswitch is a clever control panel built by Mirego that allows mobile developers to apply runtime version-specific behaviors to their iOS or Android application.

Installation

npm install react-native-killswitch

Usage

The bare minimum needed to have a working killswitch is API keys for iOS and Android, the app language and the app version:

import { useKillswitch } from 'react-native-killswitch';

const { isOk } = useKillswitch({
  iosApiKey: iosApiKey,
  androidApiKey: androidApiKey,
  language: myAppLanguage,
  version: myAppVersion,
});

Options

  • iosApiKey A string taken from your killswitch back-end. The killswitch back-end will use this to send the correct behavior to your iOS users.

  • androidApiKey A string taken from your killswitch back-end. The killswitch back-end will use this to send the correct behavior to your Android users.

  • language A language code like "en" or "de". The killswitch back-end will use this to send a localized message to your users.

  • version A version number like "1.0.0". The killswitch back-end will use this to send the correct behavior to your users.

  • apiHost The host of the killswitch back-end.

  • useNativeUI Use native alerts to display messages. Defaults to true

  • timeout A number of milliseconds to wait for the back-end before returning isOk = true. Defaults to 2000

License

react-native-killswitch is © 2023 Mirego and may be freely distributed under the New BSD license. See the LICENSE.md file.

The shield logo is based on this lovely icon by Kimmi Studio, from The Noun Project. Used under a Creative Commons BY 3.0 license.

About Mirego

Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of talented people who imagine and build beautiful Web and mobile applications. We come together to share ideas and change the world.

We also love open-source software and we try to give back to the community as much as we can.