Skip to content

Getting Started with EFQRCode

EyreFreeᵈᵉᵛ edited this page May 8, 2017 · 5 revisions

EFQRCode is a tool to generate QRCode image or recognize QRCode from image, in Swift. It is based on CoreImage.

  • Generation: Create pretty two-dimensional code image with input watermark or icon;
  • Recognition: Recognition rate is higher than simply CIDetector.

中文介绍

Overview

Demo

To run the example project, clone the repo, demos are in the 'Examples' folder.

Or you can run the following command in terminal:

git clone git@github.com:EyreFree/EFQRCode.git; cd EFQRCode/Examples/iOS; open 'iOS Example.xcodeproj'

Requirements

  • XCode 8.0+
  • Swift 3.0+
  • iOS 8.0+ / macOS 10.11+ / tvOS 9.0+

Next Step

Follow the Installation Guide to integrate EFQRCode to your project.

Curious about what EFQRCode could do and how would it look like when used in your project? See our Cheat Sheet page, in which some useful code snippet are listed. There you can learn how to use EFQRCode in your project better.

At last, please also remember to check the full API Reference whenever you need to know more about EFQRCode.

Todo

  • Support GIF
  • Support more styles

PS

  1. Please select a high contrast foreground and background color combinations;
  2. You should use magnification instead of size if you want to improve the definition of QRCode image, you can also increase the value of them;
  3. Magnification too high/Size too long/Content too much may cause failure;
  4. It is recommended to test the QRCode image before put it into use;
  5. You can contact me if there is any problem, both Issue and Pull request are welcome.

PS of PS: I wish you can click the Star button if this tool is useful for you, thanks, QAQ...

Author

EyreFree, eyrefree@eyrefree.org

License

EFQRCode is available under the MIT license. See the LICENSE file for more info.

Clone this wiki locally