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

- old
+ new

@@ -1,11 +1,20 @@ # Apstrings -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apstrings`. To experiment with that code, run `bin/console` for an interactive prompt. +An Apple dot strings file parser in ruby. -TODO: Delete this and the text above, and describe your gem +Valid input strings file formats : +> ASCII +> +> UTF8 +> +> UTF-16lE +> +> UTF-16bE + + ## Installation Add this line to your application's Gemfile: ```ruby @@ -20,20 +29,28 @@ $ gem install apstrings ## Usage -TODO: Write usage instructions here +``` + string_file = Apstring.parse('path/to/dotStringFile') + + string_file.to_hash + + string_file.to_json + + +``` ## 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. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apstrings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/JasonWorking/apstrings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct. ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).