README.md in legion-json-1.1.7 vs README.md in legion-json-1.2.0

- old
+ new

@@ -1,13 +1,43 @@ -# Legion::Json +Legion::Json +===== -Legion::Json is part of the Legion Framework -[Issue Tracker - Jira](https://legionio.atlassian.net/projects/JSON/issues) -[Docs - Confluence](https://legionio.atlassian.net/wiki/spaces/LEGION/pages/24674324) -[RubyGems](https://rubygems.org/gems/legion-json) +Legion::Json is the JSON wrapper that is used by the LegionIO framework. It gives all other gems and extensions a single +json library to use for consistency. It wraps [multi_json](https://rubygems.org/gems/multi_json) and also [json_pure](https://rubygems.org/gems/json_pure) -## Usage -This library provides the Legion JSON parser abstraction, enabling the use of platform specific JSON parsers. -Based on the old sensu-json gem +Additional C extension style json gems can be installed like [oj](https://rubygems.org/gems/oj) and it they should be +used automatically. -## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +Supported Ruby versions and implementations +------------------------------------------------ + +Legion::Json should work identically on: + + * JRuby 9.2+ + * Ruby 2.4+ + + +Installation and Usage +------------------------ + +You can verify your installation using this piece of code: + +```bash +gem install legion-json +``` + +```ruby +require 'legion-json' +json_string = '{"foo":"bar","nested":{"hello":"world"}}' +Legion::Json.load(json_string) +Legion::Json.load(json_string, symbolize_keys: false) # symbolize_keys defaults to true + +hash = {foo: 'bar', nested: {hello: 'world'}} +Legion::Json.dump(hash) +Legion::Json.dump(hash, ) + +``` + +Authors +---------- + +* [Matthew Iverson](https://github.com/Esity) - current maintainer