Skip to content

Commit 8545911

Browse files
ascendixprascendixpr
authored
Update README.md
1 parent 4e88691 commit 8545911

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
## What is this?
44

5-
Acx.Forms.Barcode is a **Xamarin.Forms view for scanning barcodes** [based on](https://github.com/rebuy-de/rb-forms-barcode)
6-
It provides continuous scanning, aims to give high control to the user combined with high stability.
5+
Acx.Forms.Barcode is a **Xamarin.Forms view for scanning barcodes** that are based on [based on RB.Forms.Barcode](https://github.com/rebuy-de/rb-forms-barcode)
6+
It provides continuous scanning and aims to give high control to the user along with high stability.
77

8-
[Available via Nuget](https://www.nuget.org/packages/Acx.Forms.Barcode), full of awesomeness and also unicorns.
8+
[Available via Nuget](https://www.nuget.org/packages/Acx.Forms.Barcode), full of awesomeness and unicorns.
99

1010
**Please note** that the library currently supports Android and iOS.
1111

1212
We are very eager about your feedback, so do not hesitate to create an issue or feel free to improve our code via a contribution.
1313

1414
### Features
1515

16-
* Fully Xamarin.Forms compatible. Add elements on top and adapt the ui to your needs.
16+
* Fully Xamarin.Forms compatible. Add elements on top and adapt the UI to your needs.
1717
* Lots of configuration options, bindable properties and events: Torch control, rotation support, preview freezing and other fine grained controls.
1818
* Build for continuous scanning!
1919
* Utilizing [Google Play Services Vision API](https://developers.google.com/vision/) on Android for best possible barcode scanning performance.
@@ -26,7 +26,7 @@ We are very eager about your feedback, so do not hesitate to create an issue or
2626
4. Add the registration call `BarcodeScannerRenderer.Init();` to your platform specific Main class.
2727
4. Use the `BarcodeScanner` class in your c# or xaml code.
2828

29-
Example Android implementation of the Init call:
29+
Example of Android implementation of the Init call:
3030

3131

3232
```
@@ -46,7 +46,7 @@ protected override void OnCreate(Bundle bundle)
4646
}
4747
```
4848

49-
Example iOS implementation of the Init call:
49+
Example of iOS implementation of the Init call:
5050

5151

5252
```
@@ -68,25 +68,25 @@ public override bool FinishedLaunching(UIApplication app, NSDictionary options)
6868

6969
## Usage
7070

71-
1. Create an instance of the `BarcodeScanner` class. Dont forget to give it a height and width.
71+
1. Create an instance of the `BarcodeScanner` class. Don't forget to give it a height and width.
7272
2. Register an EventHandler for the `BarcodeScanner.BarcodeChanged` event to receive the detected barcodes.
7373

74-
For a hands-on experience it is recommended to [take a look at the sample application](#sample).
74+
For a hands-on experience, it is recommended to [take a look at the sample application](#sample).
7575

7676
### Please note
7777

78-
**Since beta 0.5.0** the library only handles the most basic camera controls. The scanning starts as soon as the element is visible on screen and stops when the view element gets removed from the stack.
78+
**Since beta 0.5.0**, the library only handles the most basic camera controls. The scanning starts as soon as the element is visible on the screen and stops when the view element gets removed from the stack.
7979

80-
Given the complexity of apps there are a lot of combinations that prevent a reasonable automatic control of the camera. For example when [sleeping](Sample/Sample.Pcl/Pages/ScannerPage.xaml.cs#L18)/[resuming](Sample/Sample.Pcl/Pages/ScannerPage.xaml.cs#L19) the device, when the [page gets disposed](Sample/Sample.Pcl/Pages/ScannerPage.xaml.cs#L74-L76) without notifying the view or another page get pushed onto the stack.
80+
Given the complexity of apps, there are a lot of combinations that prevent a reasonable automatic control of the camera. For example, when [sleeping](Sample/Sample.Pcl/Pages/ScannerPage.xaml.cs#L18)/[resuming](Sample/Sample.Pcl/Pages/ScannerPage.xaml.cs#L19) the device, when the [page gets disposed](Sample/Sample.Pcl/Pages/ScannerPage.xaml.cs#L74-L76) without notifying the view or another page get pushed onto the stack.
8181

82-
Thats why you should weave in camera control code into the logic of your app by utilizing the offered bindings. Not doing so might lead to bad performance or unexpected camera exceptions.
82+
That's why you should weave in camera control code into the logic of your app by utilizing the offered bindings. Not doing so might lead to bad performance or unexpected camera exceptions.
8383

8484
Android Do's:
8585

8686
* Disable the preview when you add a page to the navigation stack.
8787
* Disable the camera when the page gets removed from the stack.
8888
* Disable the camera when sleeping the device.
89-
* Ensure that only one instance at at time is active.
89+
* Ensure that only one instance currently is active.
9090

9191
### Bindable properties and events
9292

@@ -95,22 +95,22 @@ All events are also available as `Command`s, the appropriate fields are suffixed
9595
What | Type | Description
9696
---- | ---- | -----------
9797
`BarcodeScanner.BarcodeChanged` | EventHandler | Raised only when the barcode text changes.
98-
`BarcodeScanner.BarcodeDecoded` | EventHandler | Raised every time when a barcode is decoded from the preview, even if the value is the same as the previews one.
98+
`BarcodeScanner.BarcodeDecoded` | EventHandler | Raised every time when a barcode is decoded from the preview, even if the value is the same as the preview one.
9999
`BarcodeScanner.PreviewActivated` | EventHandler | Raised after the preview image gets active.
100100
`BarcodeScanner.PreviewDeactivated` | EventHandler | Raised after the preview image gets deactivated.
101101
`BarcodeScanner.CameraOpened` | EventHandler | Raised after the camera was obtained.
102102
`BarcodeScanner.CameraReleased` | EventHandler | Raised after the camera was released.
103103
`BarcodeScanner.Barcode` | Property | Holds the value of the last found barcode.
104104
`BarcodeScanner.IsEnabled` | Property | If `true` opens the camera and activates the preview. `false` deactivates the preview and releases the camera.
105-
`BarcodeScanner.PreviewActive` | Property | If `true` the preview image gets updated. `false` no preview for you!
105+
`BarcodeScanner.PreviewActive` | Property | If `true` the preview image gets updated. `false` means no preview for you!
106106
`BarcodeScanner.BarcodeDecoder` | Property | If `true` the decoder is active and tries to decode barcodes out of the image. `false` turns the decoder off, the preview is still active but barcodes will not be decoded.
107107
`BarcodeScanner.Torch` | Property | Controls the camera flashlight if available and accessible. `true` sets the camera to torch mode (always on), `false` turns the flashlight off.
108108

109109
### Configuration
110110

111111
Configuration can be applied by passing a `Configuration` object to the `BarcodeScannerRenderer.Init()` method. As the available options are platform specific, the configuration has to be done in the according platform solution. The corresponding [Android](Acx.Forms.Barcode.Droid/Configuration.cs) class documentation should give you a solid understanding of the available options.
112112

113-
By default the compatibility mode is enabled to ensure the highest device compatibility.
113+
The compatibility mode is enabled to ensure the highest device compatibility by default.
114114

115115
Simple example:
116116

@@ -123,7 +123,7 @@ Simple example:
123123

124124
### Debugging
125125

126-
Acx.Forms.Barcode provides you with a tremendous amount of debug information, so check your application log if anything goes wrong:
126+
Acx.Forms.Barcode provides you with a tremendous amount of debug information, so check your application logs if anything goes wrong:
127127

128128
```
129129
[Acx.Forms.Barcode] [BarcodeScannerRenderer] OnElementChanged
@@ -149,7 +149,7 @@ Decoded barcode [886970911399 - UpcA]
149149

150150
### FAKE options / Tasks
151151

152-
Execute `bin/fake <taskname>` to run a task or `bin/fake --<optionname>` for fake cli options. First run `bin/fake install`.
152+
Execute `bin/fake <taskname>` to run a task or `bin/fake --<optionname>` for fake CLI options. First run `bin/fake install`.
153153

154154
(We are currently only supporting OSX to build the solution with FAKE. Feel free to add support for other platforms)
155155

0 commit comments

Comments
 (0)