lister 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99e9873f61a1b837630882ec61bd6f90a173ca7b
-  data.tar.gz: 7f497d5393c504f194ac30c4781d2ca098b91075
+  metadata.gz: 995fb1ba3b99de605988d2f199599c76db78f76f
+  data.tar.gz: 4e59210040f140eee60c212e1097e97b4bb42884
 SHA512:
-  metadata.gz: b6f528658a95e6e4cdbf612261c258f95c4059f0ebb502257fbb988623dc115ce7260494d77980e11bd63b0f2c0d8b7ce37ed2984c6313aab59cfeb940ab0bd9
-  data.tar.gz: a34c0ce0e28ec72482ab9e7e30d489050068d1192e89eb6c21f36908f5e507c22ffe4c8ebb1b294cc96edb6d17a585a8836c09e6f13f6532d29a8cfd80d1f0a2
+  metadata.gz: 1f1f60add3a3037f8b3f54a989d0140052c025f24af6d8c45eaef6ead576939ad8aab214f448afa2065234777a2eea40a1979d658348c0089ab5213849dcbe95
+  data.tar.gz: eb1093ec574f603cddf5617656528c985273d08e69b6e91e0d618e5c4434828fe12534f986fdc5698b0ff8768164aeba98b33a901633c05c4c43bd5f49bdc553

data/README.md

@@ -1,6 +1,6 @@
 # Lister
 
-TODO: Write a gem description
+This gem allows you to create a series of waypoints that lead to a final stash. Put whatever you want in the final treasure and put objects that work as hints or mini-treasures in the waypoints.
 
 ## Installation
 
@@ -16,9 +16,35 @@ Or install it yourself as:
 
     $ gem install lister
 
+
 ## Usage
 
-TODO: Write usage instructions here
+Create a new treasure hunt by saving TreasureHunt.new to a variable with whatever you want as a final prize:
+
+    $ hunt = TreasureHunt.new("Loot!")
+
+Add locations for hints leading to the loot by using:
+
+    $ hunt.add_waypoint("X marks the spot.")
+
+Hints don't have to be strings:
+
+    $ hunt.add_waypoint(:buried_key)
+
+Search for a waypoint you've added by what's hidden there:
+
+    $ hunt.search(:buried_key)
+
+Remove waypoints you've created but don't want anymore with remove(waypoint):
+
+    $ waypoint1 = hunt.add_waypoint("X marks the spot.")
+    $ waypoint2 = hunt.add_waypoint(:buried_key)
+    $ hunt.remove(waypoint1)
+
+Print out a list of all the hints you have buried at waypoints so far by using:
+
+    $ hunt.to_s
+
 
 ## Contributing
 

data/lib/lister/version.rb

@@ -1,3 +1,3 @@
 module Lister
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lister
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - xdothackerx