From 88e387eb8fa8e6744f083cdf1b891351c0e1f354 Mon Sep 17 00:00:00 2001 From: David Vittori Date: Sat, 21 Aug 2021 15:28:53 +0200 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d88afb9..b67439a 100644 --- a/README.md +++ b/README.md @@ -7,16 +7,34 @@ Component to generate QRCode, Code128, PDF417 or AZTEC natively for react native ```sh npm install react-native-barcode-creator ``` +Go to your ios folder and run: +```sh +pod install +``` ## Usage ```js -import BarcodeCreator from "react-native-barcode-creator"; +import BarcodeCreatorViewManager, { BarcodeFormat } from 'react-native-barcode-creator'; + + + +``` -// ... +## Props -const result = await BarcodeCreator.multiply(3, 7); -``` +| Prop | Description | Default | +| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| **`value`** | **Mandatory** - The content to add to the Barcode. | _None_ | +| **`style`** | Style attributes for the view, as expected in a standard [`View`](https://facebook.github.io/react-native/docs/layout-props.html). | _None_ | +| **`format`** | **Mandatory** The format to show in the Barcode, it can be QR, AZTEC, PDF417, CODE128. | `BarcodeFormat.QR` | +| **`background`** | The Background Color of the Barcode. | `white` | +| **`foregroundColor`** | The foreground color to use on the Barcode. | `black` ## Contributing