lister 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +28 -2
- data/lib/lister/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 995fb1ba3b99de605988d2f199599c76db78f76f
|
|
4
|
+
data.tar.gz: 4e59210040f140eee60c212e1097e97b4bb42884
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1f1f60add3a3037f8b3f54a989d0140052c025f24af6d8c45eaef6ead576939ad8aab214f448afa2065234777a2eea40a1979d658348c0089ab5213849dcbe95
|
|
7
|
+
data.tar.gz: eb1093ec574f603cddf5617656528c985273d08e69b6e91e0d618e5c4434828fe12534f986fdc5698b0ff8768164aeba98b33a901633c05c4c43bd5f49bdc553
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Lister
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
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.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -16,9 +16,35 @@ Or install it yourself as:
|
|
|
16
16
|
|
|
17
17
|
$ gem install lister
|
|
18
18
|
|
|
19
|
+
|
|
19
20
|
## Usage
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
Create a new treasure hunt by saving TreasureHunt.new to a variable with whatever you want as a final prize:
|
|
23
|
+
|
|
24
|
+
$ hunt = TreasureHunt.new("Loot!")
|
|
25
|
+
|
|
26
|
+
Add locations for hints leading to the loot by using:
|
|
27
|
+
|
|
28
|
+
$ hunt.add_waypoint("X marks the spot.")
|
|
29
|
+
|
|
30
|
+
Hints don't have to be strings:
|
|
31
|
+
|
|
32
|
+
$ hunt.add_waypoint(:buried_key)
|
|
33
|
+
|
|
34
|
+
Search for a waypoint you've added by what's hidden there:
|
|
35
|
+
|
|
36
|
+
$ hunt.search(:buried_key)
|
|
37
|
+
|
|
38
|
+
Remove waypoints you've created but don't want anymore with remove(waypoint):
|
|
39
|
+
|
|
40
|
+
$ waypoint1 = hunt.add_waypoint("X marks the spot.")
|
|
41
|
+
$ waypoint2 = hunt.add_waypoint(:buried_key)
|
|
42
|
+
$ hunt.remove(waypoint1)
|
|
43
|
+
|
|
44
|
+
Print out a list of all the hints you have buried at waypoints so far by using:
|
|
45
|
+
|
|
46
|
+
$ hunt.to_s
|
|
47
|
+
|
|
22
48
|
|
|
23
49
|
## Contributing
|
|
24
50
|
|
data/lib/lister/version.rb
CHANGED