Skip to content

Commit 5deb5ba

Browse files
committed
doc(wrappers/ios): add basic usage section in iOS readme
1 parent ad63f53 commit 5deb5ba

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

wrappers/ios/README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
11
# ZXingCpp iOS Framework
22

3-
Add the iOS wrapper either as a local Swift Package by adding it as a dependency to your app or add the repository, the Package.swift file is automatically picked.
3+
## Usage
4+
5+
For general usage, please compare the source code provided in the demo project.
6+
7+
### Swift PM
8+
9+
As this repository provides a `Package.swift` on root level, you can add `zxing-cpp` including wrapper code by adding a Package Dependency in Xcode.
10+
11+
An alternative way is to check this repository out and add it as a local Swift Package by adding it as dependency to your app.
12+
13+
### CocoaPods
14+
15+
As an alternative way, you can also rely on [CocoaPods](https://cocoapods.org/pods/zxing-cpp). Just add the Pod as dependency, for instance:
16+
17+
```
18+
pod 'zxing-cpp'
19+
```
20+
21+
If you just need the core without the wrapper code, you can also rely on:
22+
23+
```
24+
pod 'zxing-cpp/Core'
25+
```
26+
27+
The module to be imported is named `ZXingCpp`.

zxing-cpp.podspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Pod::Spec.new do |s|
44
s.summary = 'C++ port of ZXing'
55
s.homepage = 'https://github.com/zxing-cpp/zxing-cpp'
66
s.author = 'axxel'
7+
s.readme = 'https://raw.githubusercontent.com/zxing-cpp/zxing-cpp/master/wrappers/ios/README.md'
78
s.license = {
89
:type => 'Apache License 2.0',
910
:file => 'LICENSE'

0 commit comments

Comments
 (0)