walk_up 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b8adaff0ebe4f2e7082e7d5ed6df7178c7a28868a729cf925b0fd148d25b72
-  data.tar.gz: 6759b28f721367610eb6b811ef81f0b0495543cd01c6ecbd5cf364d93f026179
+  metadata.gz: 62c56ae4b12a7c802b862995a412640ee82a1cc6b7b4a755553a08505af29451
+  data.tar.gz: '08951e1186782c7df643e477dbf743a8b73ae148702bf29da3b0865fa7014275'
 SHA512:
-  metadata.gz: 9ceb117b845c01730d5cc125d17a168f471e46058ee8c944de541349a3fad49b0ed7787e5ea611b70c53941502a61e14962853c0452d8cc07ca0995fcfd6dea2
-  data.tar.gz: 525887940580607a18e60d033915ca478295762ac595a135d8cb7c8bd15ab91c3fbd2f179c556cb24db521b787a411421aa4c1eb000b9d048795131f5fd6e802
+  metadata.gz: 1bb08a1f38a2148b9894a3572ab187ca0b5f4150be810a034b22d3885a1b5bede540745127f1bf2cc21befdfc02e99cba32ef2eb68dce25b4c946430c3d7c597
+  data.tar.gz: 17f9eb82b8f87a91fae6de111b1014b8e1f0da04d967fb96d7f542d991c0b4d70837903d7cfb8e722775e887a2c7decef7db52515e60d138a35dc209e803bd7b

data/README.md

@@ -1,3 +1,13 @@
+# What is this?
+
+A simple function for walking up a file directory until a certain file is found.
+
+```ruby
+require "walk_up"
+
+require_relative walk_up_until("globals.rb") # <- will keep looking in parent directories for a "globals.rb" file
+```
+
 # Setup
 
 Everything is detailed in the `documentation/setup.md`!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: walk_up
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jeff Hykin
@@ -10,7 +10,14 @@ bindir: bin
 cert_chain: []
 date: 2021-09-10 00:00:00.000000000 Z
 dependencies: []
-description: ''
+description: |2
+          A simple function for walking up a file directory until a certain file is found.
+
+          ```ruby
+          require "walk_up"
+
+          require_relative walk_up_until("globals.rb") # <- will keep looking in parent directories for a "globals.rb" file
+          ```
 email:
 executables: []
 extensions: []