diff --git a/README.md b/README.md index 027605c..d6e7319 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ This library isn't intended to "scan" these barcodes, but rather parse the data # BarcodeFile(header=FileHeader(issuer_id=636000, aamva_version=10, number_of_entries=2, jurisdiction_version=1), subfiles=(Subfile(subfile_type='DL', elements={'DAQ': 'T64235789', 'DCS': 'SAMPLE', 'DDE': 'N', 'DAC': 'MICHAEL', 'DDF': 'N', 'DAD': 'JOHN', 'DDG': 'N', 'DCU': 'JR', 'DCA': 'D', 'DCB': 'K', 'DCD': 'PH', 'DBD': '06062019', 'DBB': '06061986', 'DBA': '12102024', 'DBC': '1', 'DAU': '068 in', 'DAY': 'BRO', 'DAG': '2300 WEST BROAD STREET', 'DAI': 'RICHMOND', 'DAJ': 'VA', 'DAK': '232690000 ', 'DCF': '2424244747474786102204', 'DCG': 'USA', 'DCK': '123456789', 'DDA': 'F', 'DDB': '06062018', 'DDC': '06062020', 'DDD': '1'}), Subfile(subfile_type='ZV', elements={'ZVA': '01'}))) ``` -Currently in `v0.5-beta` the we can take the barcode file string (captured from a barcode scanning tool) and break it down into it's various parts. These parts are the file header, subfiles, and subfile elements. +Currently in `v0.5-beta` the library can take the barcode string (captured from a barcode scanning tool) and break it down into it's various file parts. These parts are the file header, subfiles, and subfile elements. -The subfile elements is where the profile is stored. This is information like first name, last name, birthday, etc. Profile propertie names like `customer_family_name` are too large for the limited space of the barcode so all property names have been encoded with a three letter name, like `DCS`. This is a form of compression the barcode file uses. +The subfile elements are where the profile properties are stored. This is information like first name, last name, birthday, etc. Profile property names like `customer_family_name` are too large for the limited space of the barcode, so all property names have to be encoded with a three letter name, like `DCS`. The AAMVA Standard lists the decoded names for each property in Annex D. -In addition to encoding property names, many properties have different encoding methods for their values. For example gender is represented by an int. 1 = male, 2 = female, 9 = not specified. +In addition to encoding the property names, many properties have different encoding methods for their values. For example gender is represented by an integer. 1 = male, 2 = female, 9 = not specified. The next step in the development process is to decode each of the subfile element into human readable propeties.