fixed project struct and readme

shakurocom · Sep 30, 2022 · cb86ea5 · cb86ea5
1 parent f3a7bdb
commit cb86ea5
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/GS1BarcodeParser.xcworkspace/contents.xcworkspacedata b/GS1BarcodeParser.xcworkspace/contents.xcworkspacedata
diff --git a/GS1BarcodeParser_Framework.xcodeproj/project.pbxproj b/GS1BarcodeParser_Framework.xcodeproj/project.pbxproj
@@ -54,10 +54,10 @@
 				6B6FC10428C9EE0D00C7F760 /* README.md */,
 				6BD6F08C28CB30B900E5E7EB /* Shakuro.GS1BarcodeParser.podspec */,
 				6BB6A4B928D4A9760006D7D1 /* .swiftlint.yml */,
+				6B6FC11428C9F0B400C7F760 /* Source */,
 				6B6FC0D728C9E8D900C7F760 /* GS1BarcodeParser_Framework */,
 				5042595121338FAB4DAB60CF /* Pods */,
 				6B6FC0D628C9E8D900C7F760 /* Products */,
-				6B6FC11428C9F0B400C7F760 /* Source */,
 			);
 			sourceTree = "<group>";
 		};

diff --git a/README.md b/README.md
@@ -11,6 +11,9 @@
 - [Usage](#usage)
 - [License](#license)
 
+A `GS1BarcodeParser` provides parsing of GS1 Barcodes.
+Library also provides general purpose validator for barcode's content.
+
 ## Requirements
 
 - iOS 11.0+
@@ -39,6 +42,19 @@ If you prefer not to use CocoaPods, you can integrate Shakuro.GS1BarcodeParser s
 
 ## Usage
 
+### Parser
+
+    let barcodeParser = GS1BarcodeParser()
+    barcodeParser.validation = .none // .soft, .hard
+    var barcodeElements: [GS1Barcode.Element] = []
+
+    let barcode: String = "8017123456789012345678\u{1D}8018123456789012345678\u{1D}80191234567890"
+    do {
+        barcodeElements = try barcodeParser.parse(string: barcode).elements
+    } catch let error {
+        // handle error
+    }
+
 Have a look at the [GS1BarcodeParser_Example](https://github.com/shakurocom/GS1BarcodeParser/tree/master/GS1BarcodeParser_Example)
 
 ## License