Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Added new roadmap ideas.
  • Loading branch information
benjohnde authored Jul 27, 2017
1 parent 7dc746b commit 9420f98
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
ZXingObjC
=========
# ZXingObjC

ZXingObjC is a full Objective-C port of [ZXing](https://github.com/zxing/zxing) ("Zebra Crossing"), a Java barcode image processing library. It is designed to be used on both iOS devices and in Mac applications.

Expand All @@ -20,9 +19,13 @@ The following barcodes are currently supported for both encoding and decoding:

ZXingObjC currently has feature parity with ZXing version 3.0.

## Roadmap

Sorry, this project had some sort of winter sleep for a long time. There were also some ideas to rewrite this project in Swift. Instead of rewriting the project in Swift as a whole, we planned to keep up feature parity with zxing-core at first, then rewrite the capture module as well as the examples in Swift. From this new starting point, we are going to replace classes step-by-step with new Swift implementations. We do not want to create a new barcode scanner but to keep the code as similar as possible to zxing-core.

## Requirements

ZXingObjC requires Xcode 5, targeting either iOS 6.0 and above, or Mac OS X 10.8 Mountain Lion and above.
ZXingObjC requires Xcode 8.3.3, targeting either iOS 8.0 and above, or Mac OS X 10.8 Mountain Lion and above.

## Usage

Expand Down Expand Up @@ -78,14 +81,7 @@ if (result) {

## Installation

#### CocoaPods

The recommended way to install ZXingObjC is with [CocoaPods](http://cocoapods.org), a dependency mananger for Objective-C projects. After installing CocoaPods just add ZXingObjC to your Podfile:

```ruby
platform :ios, '7.0'
pod 'ZXingObjC', '~> 3.2.1'
```
We highly recommend Carthage as module manager.

#### Carthage

Expand All @@ -95,6 +91,15 @@ Alternatively, ZXingObjC can be installed using [Carthage](https://github.com/Ca
github "TheLevelUp/ZXingObjC" ~> 3.2.1
```

#### CocoaPods

The recommended way to install ZXingObjC is with [CocoaPods](http://cocoapods.org), a dependency mananger for Objective-C projects. After installing CocoaPods just add ZXingObjC to your Podfile:

```ruby
platform :ios, '7.0'
pod 'ZXingObjC', '~> 3.2.1'
```

## Examples

ZXingObjC includes several example applications found in "examples" folder:
Expand Down

0 comments on commit 9420f98

Please sign in to comment.