Merge pull request #4 from customink/cmurphy/fix_ootb_setup_experience

Improve the out-of-the-box development experience for this gem

Author: chmurph2

.ruby-version

@@ -0,0 +1 @@
+2.6.6

Brewfile

@@ -0,0 +1,2 @@
+# Add homebrew-based depencencies here
+brew 'coreutils' # Dependencies for natively compiling the json gem. See https://www.gnu.org/software/coreutils/

CHANGELOG.md

@@ -1,5 +1,11 @@
 # IsItUp Changelog
 
+## 0.0.4
+- Added `.ruby-version` file with a recent version of Ruby
+- Added `Brewfile` with the GNU coreutils dependency
+- Added `bin/bootstrap_macos` to help macOS users get bootstrapped for development
+- Updated README with additional instructions for getting started
+
 ## 0.0.3
 - Added `bin/console` for local testing
 - Added `bin/setup` for easier installation

README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-IsItUp provides one monitoring URI that returns a JSON response:
+IsItUp provides a monitoring URI that returns a JSON response:
 
 ```ruby
 % curl your-domain/is_it_up
@@ -30,10 +30,12 @@ IsItUp provides one monitoring URI that returns a JSON response:
 ## Contributing
 
 1. Fork it ( http://github.com/customink/is_it_up/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`)
-5. Create new Pull Request
+2. Run `bin/bootstrap_macos` (if using macOS) and `bin/setup` to ensure your environment is configured for development
+3. Run `bin/test` to ensure all tests pass
+4. Create your feature branch (`git checkout -b my-new-feature`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
 
 ## Kudos
 

bin/bootstrap_macos

@@ -0,0 +1,18 @@
+
+#!/bin/sh
+
+# script/bootstrap: Resolve all dependencies that the application requires to
+# run.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ]; then
+  brew bundle check || {
+    echo "==> Installing Homebrew dependencies..."
+    brew bundle
+  }
+fi
+
+brew bootstrap-rbenv-ruby

lib/is_it_up/version.rb

@@ -1,3 +1,3 @@
 module IsItUp
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end