README.md in data_set-1.1.0 vs README.md in data_set-2.0.0
- old
+ new
@@ -1,29 +1,37 @@
# DataSet
[](http://badge.fury.io/rb/data_set)
-[](https://github.com/jeffnyman/data_set/blob/master/LICENSE.txt)
+[](https://github.com/jeffnyman/data_set/blob/master/LICENSE.md)
-[](https://gemnasium.com/jeffnyman/data_set)
-
DataSet provides an easy mechanism to load up a set of data from a YAML file and then access that data by the structuring keys of the file. This provides an expressive way to retrieve data values.
## Installation
To get the latest stable release, add this line to your application's Gemfile:
```ruby
gem 'data_set'
```
-And then include it in your bundle:
+To get the latest code:
- $ bundle
+```ruby
+gem 'data_set', git: 'https://github.com/jeffnyman/data_set'
+```
+After doing one of the above, execute the following command:
+
+```
+$ bundle
+```
+
You can also install DataSet just as you would any other gem:
- $ gem install data_set
+```
+$ gem install data_set
+```
## Usage
To use DataSet you can either specify a directory and file for loading or rely on the defaults. By default, DataSet will look for files in a `data` directory relative to the executing script. Also by default, DataSet will read a file named `default.yml` from that directory. These defaults apply if you don't specify anything to the contrary.
@@ -116,12 +124,16 @@
This would allow the specific environment variable to be set conditionally based on execution.
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec:all` 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`.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec:all` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The default `rake` command will run all tests as well as a RuboCop analysis.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/jeffnyman/data_set](https://github.com/jeffnyman/data_set). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another testing tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
To contribute to DataSet:
@@ -141,6 +153,6 @@
This code is loosely based upon the [FigNewton](https://github.com/cheezy/fig_newton) gem. I created a new version largely to avoid the name "FigNewton" as well as cleaning up the code and the documentation.
## License
DataSet is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
-See the [LICENSE](https://github.com/jeffnyman/data_set/blob/master/LICENSE.txt) file for details.
+See the [LICENSE](https://github.com/jeffnyman/data_set/blob/master/LICENSE.md) file for details.