Skip to content

Commit eb9319a

Browse files
committed
Updated readme
1 parent 253374d commit eb9319a

1 file changed

Lines changed: 10 additions & 18 deletions

File tree

README.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,22 @@
11
<p align="center">
22
<img width="345" height="120" src="https://raw.githubusercontent.com/G00fY2/quickie/gh-pages/media/logo.png">
33
</p>
4+
This repository is forked from https://github.com/G00fY2/quickie. This readme has been altered to reflect Makeables fork of the library.
5+
6+
47

58
**quickie** is a Quick Response (QR) Code scanning library for Android that is based on CameraX and ML Kit on-device barcode detection. It's an alternative to ZXing based libraries and written in Kotlin. **quickie** features:
9+
610
- Easy API for launching the QR scanner and receiving results by using the new Activity Result API
711
- Modern design, edge-to-edge scanning view with multilingual user hint
812
- Android Jetpack CameraX for communicating with the camera and showing the preview
913
- ML Kit Vision API for best, fully on-device barcode recognition and decoding
1014

1115
> **Note**: At Google I/O 2022 the [Google code scanner](https://developers.google.com/ml-kit/code-scanner) was announced. You should consider using it instead of quickie unbundled. If you want to support devices without Play Services or like to ship the latest ML Kit model - use quickie bundled.
1216
13-
## Download [![Maven Central](https://img.shields.io/maven-central/v/io.github.g00fy2.quickie/quickie-unbundled)](https://search.maven.org/search?q=g:io.github.g00fy2.quickie)
14-
There are two different flavors available on `mavenCentral()`:
15-
16-
| Bundled | Unbundled |
17-
|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|
18-
| ML Kit model is bundled inside app (independent of Google Services) | ML Kit model will be automatically downloaded via Play Services (once while installing/updating the app) |
19-
| About 2.5 MB app size increase per ABI (you should use App Bundle or ABI splitting) | About 550 KB app size increase |
20-
| V3 model is used (faster, more accurate) | Currently V1 model will be downloaded |
21-
17+
## Download [![](https://jitpack.io/v/makeabledk/code-scanner-android.svg)](https://jitpack.io/#makeabledk/code-scanner-android)
2218
```kotlin
23-
// bundled:
24-
implementation("io.github.g00fy2.quickie:quickie-bundled:1.6.0")
25-
26-
// unbundled:
27-
implementation("io.github.g00fy2.quickie:quickie-unbundled:1.6.0")
19+
implementation 'com.github.makeabledk:code-scanner-android:1.7.0'
2820
```
2921

3022
## Quick Start
@@ -146,18 +138,18 @@ Thanks to everyone who contributed to quickie!
146138
147139
## License
148140
The MIT License (MIT)
149-
141+
150142
Copyright (C) 2022 Thomas Wirth
151-
143+
152144
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
153145
associated documentation files (the "Software"), to deal in the Software without restriction,
154146
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
155147
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
156148
subject to the following conditions:
157-
149+
158150
The above copyright notice and this permission notice shall be included in all copies or substantial
159151
portions of the Software.
160-
152+
161153
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
162154
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
163155
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,

0 commit comments

Comments
 (0)