diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f08428e..b3200e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,6 +43,13 @@ Read the READMEs in [`android/`](android/README.md) and [`ios/`](ios/README.md) > Run `yarn check-android` to validate codestyle +### Docs + +1. Edit the relevant file, it may be easiest to search for what you're editing to find the right file +2. Install all dependencies by running `yarn` inside the `docs` folder + +> Run `yarn start` to generate the docs, you can then view them in your browser to confirm your changes + ## Committing We love to keep our codebases clean. To achieve that, we use linters and formatters which output errors when something isn't formatted the way we like it to be. diff --git a/docs/docs/guides/FRAME_PROCESSOR_CREATE_PLUGIN_ANDROID.mdx b/docs/docs/guides/FRAME_PROCESSOR_CREATE_PLUGIN_ANDROID.mdx index 546904b..bc5ca2d 100644 --- a/docs/docs/guides/FRAME_PROCESSOR_CREATE_PLUGIN_ANDROID.mdx +++ b/docs/docs/guides/FRAME_PROCESSOR_CREATE_PLUGIN_ANDROID.mdx @@ -75,6 +75,19 @@ public class QRCodeFrameProcessorPluginPackage implements ReactPackage { } ``` +6. Register the package in MainApplication.java + +```java {6} + @Override + protected List getPackages() { + @SuppressWarnings("UnnecessaryLocalVariable") + List packages = new PackageList(this).getPackages(); + ... + packages.add(new QRCodeFrameProcessorPluginPackage()); // <- add + return packages; + } +``` + @@ -121,6 +134,19 @@ class QRCodeFrameProcessorPluginPackage : ReactPackage { } ``` +6. Register the package in MainApplication.java + +```java {6} + @Override + protected List getPackages() { + @SuppressWarnings("UnnecessaryLocalVariable") + List packages = new PackageList(this).getPackages(); + ... + packages.add(new QRCodeFrameProcessorPluginPackage()); // <- add + return packages; + } +``` + diff --git a/src/PhotoFile.ts b/src/PhotoFile.ts index 410e413..d1c3e31 100644 --- a/src/PhotoFile.ts +++ b/src/PhotoFile.ts @@ -4,9 +4,9 @@ export interface TakePhotoOptions { /** * Indicates how photo quality should be prioritized against speed. * - * * `"quality"` Indicates that speed of photo delivery is most important, even at the expense of quality + * * `"quality"` Indicates that photo quality is paramount, even at the expense of shot-to-shot time * * `"balanced"` Indicates that photo quality and speed of delivery are balanced in priority - * * `"speed"` Indicates that photo quality is paramount, even at the expense of shot-to-shot time + * * `"speed"` Indicates that speed of photo delivery is most important, even at the expense of quality * * @platform iOS 13.0+ * @default "balanced"