README.md in apstrings-0.2.0 vs README.md in apstrings-0.2.1

- old
+ new

@@ -1,8 +1,8 @@ # Apstrings -An Apple dot strings file parser in ruby. +Apple dot strings file parser and validator in ruby. Valid input strings file formats : > ASCII > @@ -29,18 +29,34 @@ $ gem install apstrings ## Usage + +####1. Parse a .strings file to json/hash in ruby : ``` - string_file = Apstring.parse('path/to/dotStringFile') +require 'apstrings' + + + string_file = Apstring.parse('path/to/dotStringFile.strings') - string_file.to_hash + string_file.to_hash # => {key1 => value1 , key2 = > value2 ...} string_file.to_json ``` + + +####2. Run a validation for a .strings file and (optionally) compare a master .strings file to find missing keys. + +``` +require 'apstrings' + +Apstrings.validate('path/to/dotStringFile.strings','path/to/masterDotStringFile.strings') + +``` + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake true` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.