metastore 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1abd762a9bf15920fe6a4fcb570da88fc6cdbb04
-  data.tar.gz: fb006ace0d643e03012271353248d3b4bf224bf7
+  metadata.gz: 7cca3216af0666502760ad04279db43a9a8bc57f
+  data.tar.gz: 768a7cbf250acfd0b2d7f06e87606611d733aa23
 SHA512:
-  metadata.gz: 60b555b170ad5cf1befcd75a379f256715a14b1e544c7518eaf6503bcd3b88b9b8829b79d0c1564a2712403455d2f69d2a7774533bf42b0e14c7245e09b0defd
-  data.tar.gz: ae34d4a36e98d1bd3fb0b06f9fe815060f98c3ffbe5bf252c18e3abfbef05b7b3e3f6aa5f2401e2ec53890d657ae859966b5b750d84e6d5b4939d0f9364669fa
+  metadata.gz: f738de3d865b98b7b7df13bf4d0b9ec70fe561fa72fe845efc8cf67875799a9a311f2af21e27ec6a170410518d2180b8750c1a174329e6df6920b6a658ed1a37
+  data.tar.gz: 6354a19e99dc4e6aae63122cc77e84feef41ee5c3398c1e44be33fb3fa3e6546e6c21b496672e3f433869e511641fdb2082e52ab9aad610baadf847261859957

data/README.md

@@ -25,17 +25,103 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+There are four public methods hanging off `Metastore::Cabinet`:
 
-## Development
+* `#get('key')` or `<Metastore::Cabinet instance>['key']`
+* `#set('key', 'value')` or `<Metastore::Cabinet instance>['key'] = 'value'`
+* `#clear!`
+* `#contents`
+
+### Setup
+
+```ruby
+require 'metastore'
+
+file = File.join(ENV['HOME'], '.metadata.yaml')
+store = Metastore::Cabinet.new(file)
+```
+
+### Basic example
+
+```ruby
+store.clear!
+=> true
+
+store.contents
+=> {}
+
+store.get('key')
+=> nil
+
+store.set('key', 'value')
+=> true
+
+store.contents
+=> {"key"=>"value"}
+
+store.get('key')
+=> "value"
+```
+
+### Advanced examples
+
+When setting values, you can nest both keys and values:
+
+```ruby
+store.clear!
+=> true
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+store.contents
+=> {}
+
+store.get('key1.key2')
+=> nil
+
+store.set('key1.key2', 'key.key2.value')
+=> true
+
+store.contents
+=> {"key1"=>{"key2"=>"key.key2.value"}}
+
+store.set('key3.key4', { 'key' => 'value' })
+=> true
+
+store.contents
+=> {"key1"=>{"key2"=>"key.key2.value"}, "key3"=>{"key4"=>{"key"=>"value"}}}
+```
+
+You can also use Hash notation:
+
+```ruby
+store.clear!
+=> true
+
+store.contents
+=> {}
+
+store['key1.key2']
+=> nil
+
+store['key1.key2'] = 'key.key2.value'
+=> true
+
+store.contents
+=> {"key1"=>{"key2"=>"key.key2.value"}}
+
+store['key3.key4'] = { 'key' => 'value' }
+=> true
+
+store.contents
+=> {"key1"=>{"key2"=>"key.key2.value"}, "key3"=>{"key4"=>{"key"=>"value"}}}
+```
+
+## Development
 
 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/metastore/fork )
+1. Fork it ( https://github.com/ashmckenzie/metastore/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/metastore/version.rb

@@ -1,3 +1,3 @@
 module Metastore
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metastore
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ash McKenzie