sqm2json 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 191066f61562113d393a00ecaec6e6cb9c1932a8
-  data.tar.gz: 74e38e30f44c7680e2dde4b7810082c9868c54b7
+  metadata.gz: d777ca4a5b2618203709bcf6ed9fc20b55881516
+  data.tar.gz: f8721a692c66988fcfdae9a030aa2d599f0769a8
 SHA512:
-  metadata.gz: 1fe57226eec5ef80f57d71ef9e3a9cdfc41cee0cabbeac5ebac37ba183ea3881b02cd43f7d98e3969a0ca505e2804ede2ef0eb2a5f5349f1d81756f45bd81977
-  data.tar.gz: 7f340ffbd0a1dcd21785324d39d3b27d78e963d97d8c29c96882bdc3a1b5d30ad82b0c678b77dca3c39de6d84c6184e7dcacb67986b51da966b7cac7a91d4589
+  metadata.gz: 92c843eb04b36af684abf23429004249059f859097801a76eb65b38e803aa44cebdedc2b45c5151296410efadef8c6ced443e7944f83cb84aed89899af078f42
+  data.tar.gz: 528b3a57c6a8d58920c392778d3bce7e11de7e37f6ffe5343b1c646e52e41080346b42158fbed637cd3f6ae1c8a513c53d0dfbbe3bce335742188c034a1907ab

data/README.md

@@ -1,4 +1,4 @@
-# Sqm2Json
+# Sqm2Json [![Gem Version](https://badge.fury.io/rb/sqm2json.svg)](https://badge.fury.io/rb/sqm2json)
 
 This gem can convert SQM mission files from Arma3 to JSON documents. And vice versa. Missions content can be either parsed easily, and generated from standard JSON representation.  
 
@@ -20,17 +20,27 @@ Or install it yourself as:
 
 ## Usage
 
-This library embeds a single module called **Sqm2Json**: include or extends it, then you can play with it:
+This library embeds a module called **Sqm2Json** and its submodule **Sqm2Json::Reverse** ;  include or extends them, then you can play with main methods:
 
+```ruby
+require 'sqm2json'
 
+class MyClass
+  include Sqm2Json,Sqm2Json::Reverse
+end
 
+mission_as_json = MyClass.new.to_json(File.read('sqm_mission_file_path'))
+mission_as_sqm  = MyClass.new.to_sqm(mission_as_json)
+```
 
-## 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.
 
-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).
+## Development
+After checking out the repo, you can run `bundle install` to install the dependencies. Then, you can run `bundle exec rake spec` to execute the tests and run `bundle exec rake yard` to build the documentation.
+You can also run `bundle exec irb` 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 `lib/sqm2json/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]/arma3. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/arma3. 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.

data/lib/sqm2json/version.rb

@@ -1,3 +1,3 @@
 module Sqm2Json
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqm2json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicolas FLINOIS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler