README.md in dsp_blueprint_parser-0.1.0 vs README.md in dsp_blueprint_parser-0.1.1

- old
+ new

@@ -1,9 +1,11 @@ # DspBlueprintParser Small Ruby gem to handle parsing of Dyson Sphere Program's blueprint data. +Currently the gem does not support validating the MD5 hash of the blueprint. It appears as if the DSP devs wrote their own MD5 algorithm which would need it's own Ruby port. + ## Installation Add this line to your application's Gemfile: ```ruby @@ -21,11 +23,14 @@ ## Usage Module `DspBlueprintParser` has a single static method `parse` which takes the DSP blueprint string to be parsed. ```ruby -DspBlueprintParser::parse(str_blueprint) +DspBlueprintParser.parse(str_blueprint) ``` + +This method returns a [BlueprintData](https://github.com/LRFalk01/DSP-Blueprint-Parser/blob/master/lib/dsp_blueprint_parser/blueprint_data.rb) object which includes the various metadata of the blueprint. +Part of the `BlueprintData` object are properties for [areas](https://github.com/LRFalk01/DSP-Blueprint-Parser/blob/master/lib/dsp_blueprint_parser/area.rb) and [buildings](https://github.com/LRFalk01/DSP-Blueprint-Parser/blob/master/lib/dsp_blueprint_parser/building.rb) which are what one would mostly be interested in further evaluating. ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.