Skip to content

Commit

Permalink
Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
priyankpat committed Jun 23, 2020
1 parent 26a74a1 commit eaa5a99
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ Capacitory community plugin for native audio engine.

## Maintainers

| Maintainer | GitHub | Social | Sponsoring Company |
| -----------| -------| -------| -------------------|
| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [N/A](https://twitter.com) | Ionic |
| Maintainer | GitHub | Social | Sponsoring Company |
| ------------- | ------------------------------------------- | ------------------------------------------------ | ------------------ |
| Priyank Patel | [priyankpat](https://github.com/priyankpat) | [@priyankpat\_](https://twitter.com/priyankpat_) | Ionic |

Mainteinance Status: Actively Maintained

# Requirement

Download [Flipper](https://fbflipper.com/), available for Linux/Windows/Mac

## Installation

To use npm
Expand Down Expand Up @@ -38,16 +42,23 @@ On Android, register the plugin in your main activity:
import com.getcapacitor.community.flipper.Flipper;

public class MainActivity extends BridgeActivity {

@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);

// Initializes the Bridge
this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
// Additional plugins you've installed go here
// Ex: add(TotallyAwesomePlugin.class);
add(Flipper.class);
}});
this.init(
savedInstanceState,
new ArrayList<Class<? extends Plugin>>() {

{
// Additional plugins you've installed go here
// Ex: add(TotallyAwesomePlugin.class);
add(Flipper.class);
}
}
);
}
}
```
Expand All @@ -58,15 +69,15 @@ No configuration required for this plugin.

## Supported methods

| Name | Android | iOS | Web
| :---- | :--- | :--- | :--- |
| initialize | ✅ | ✅ | ❌
| emulateCrash | ✅ | ❌ | ❌
| Name | Android | iOS | Web |
| :----------- | :------ | :-- | :-- |
| initialize | | | |
| emulateCrash | | | |

## Usage

```typescript
import { Plugins } from '@capacitor/core';
import { Plugins } from "@capacitor/core";

const { Flipper } = Plugins;

Expand All @@ -79,6 +90,7 @@ const { Flipper } = Plugins;
* database - boolean true/false to enable database plugin (sqlite)
* database_path - custom database path if database is not stored in application context (Android)
* @returns void
* Make sure you have flipper running in background or restart the app for plugins to communicate with flipper
*/
Flipper.configure({
enabled: true,
Expand Down

0 comments on commit eaa5a99

Please sign in to comment.