README.md in legion-settings-1.1.3 vs README.md in legion-settings-1.2.0

- old
+ new

@@ -1,49 +1,36 @@ -# Legion::Settings +Legion::Settings +===== -Legion::Settings is part of the Legion Framework +Legion::Settings is a hash like class used to store LegionIO Settings. -###Badges -####CICD -| | License | CircleCI | CodeCov | CodeBeat | -|---------|---------|----------|---------|----------| -| Master |[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)|[![CircleCI](https://circleci.com/bb/legion-io/legion-settings/tree/master.svg?style=svg)](https://circleci.com/bb/legion-io/legion-settings/tree/master)|[![codecov](https://codecov.io/bb/legion-io/legion-settings/branch/master/graph/badge.svg)](https://codecov.io/bb/legion-io/legion-settings)|[![codebeat badge](https://codebeat.co/badges/e86dbe3e-b463-4f3c-91a8-c85492fd3833)](https://codebeat.co/projects/bitbucket-org-legion-io-legion-settings-master)| -| Develop |[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)|[![CircleCI](https://circleci.com/bb/legion-io/legion-settings/tree/develop.svg?style=svg)](https://circleci.com/bb/legion-io/legion-settings/tree/develop)|[![codecov](https://codecov.io/bb/legion-io/legion-settings/branch/develop/graph/badge.svg)](https://codecov.io/bb/legion-io/legion-settings)|[![codebeat badge](https://codebeat.co/badges/e86dbe3e-b463-4f3c-91a8-c85492fd3833)](https://codebeat.co/projects/bitbucket-org-legion-io-legion-settings-develop)| +Supported Ruby versions and implementations +------------------------------------------------ -#####RubyGems -![](https://ruby-gem-downloads-badge.herokuapp.com/legion-settings) -[![Gem Version](https://badge.fury.io/rb/legion-settings.svg)](https://badge.fury.io/rb/legion-settings) +Legion::Json should work identically on: -#####Bitbucket -![](https://img.shields.io/bitbucket/issues-raw/legion-io/legion-settings.svg) -![](https://img.shields.io/bitbucket/pr-raw/legion-io/legion-settings.svg) -## Installation +* JRuby 9.2+ +* Ruby 2.4+ -Add this line to your application's Gemfile: -```ruby -gem 'legion-settings' -``` +Installation and Usage +------------------------ -And then execute: +You can verify your installation using this piece of code: - $ bundle +```bash +gem install legion-json +``` -Or install it yourself as: +```ruby +require 'legion-settings' +Legion::Settings.load(config_dir: './') # will automatically load json files it has access to inside this dir - $ gem install legion-settings +Legion::Settings[:client][:hostname] +Legion::Settings[:client][:new_attribute] = 'foobar' -## Usage +``` -This library is utilized by Legion to load config files +Authors +---------- -## Gem - -This gem can be viewed and download from [RubyGems - Legion-Settings](https://rubygems.org/gems/legion-settings) - -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/legion-io/legion-settings/issues This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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). \ No newline at end of file +* [Matthew Iverson](https://github.com/Esity) - current maintainer