waldo 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fc94e59ad3b1093f421a29e63f6f21bdbb8e22a
-  data.tar.gz: 82dc3c15f2fda149a95d8bc325b2715b966d33d8
+  metadata.gz: acbcf92e048786f3910e1a3b67f144f110aa03d8
+  data.tar.gz: 65aee7a6d20d80b3265f437e94eced1f653c519e
 SHA512:
-  metadata.gz: 21b5c9db05e9a0ef3545b6663720c5e98e945155eaebb6e3dcefc89075ede6d26b28f17d230fb423ff6c363d68bad901854dd995260597e2273d8671d6a9cf23
-  data.tar.gz: 5c610916956a0605f888f1e39b76665d5fd67f481e027258f5f3af542da2aef9db3e2840549a73de22ebc31a4475cb801f684b644dbc2df0bc7a4c5e892355bc
+  metadata.gz: 37fa1320e7268f5b04c334064c65751d0e71534382e71bea391221998bc84a2ebf0b355e234809cd7423f2600ef9c92c6b141d00f2b9c90c2f165d31928b4cc1
+  data.tar.gz: ed24f345139004b1249fa635d257d5a7fb468e95556b0ef84d90864f37e9ec3016d0c3ef9f5549c769188e9f7aead704fb2b04c8fc7e9f37dba73e9d527ebf96

data/README.md

@@ -1,15 +1,49 @@
 # Waldo
 
-Waldo is a repo meant to show you the process of making your own Ruby gem
+Waldo is a repo meant to show you the process of making your own Ruby gem. In this scenario we're making
+the gem called waldo. When you go about making your own, your name will have to be unique, and you'll need
+to swap out the information that is unique to yourself and your gem. Overall I wanted to be as transparent
+as I could about the process to show that it's not something to stress about and to give it a try!
+
+# Make GitHub and RubyGems account
+
+If you haven't done so already, this would be a great time to make yourself a GitHub account
+and a RubyGems.org account. These will be used later in the tutorial.
 
 # Process
 
+## Install bundler
+
+This step is optional if you already have it, but will be required for this tutorial.
+
+    $ gem install bundler
+
 ## Generate the gem
 
-`bundle gem waldo`
+```
+$ bundle gem waldo
+
+Creating gem 'waldo'...
+MIT License enabled in config
+Code of conduct enabled in config
+      create  waldo/Gemfile
+      create  waldo/.gitignore
+      create  waldo/lib/waldo.rb
+      create  waldo/lib/waldo/version.rb
+      create  waldo/waldo.gemspec
+      create  waldo/Rakefile
+      create  waldo/README.md
+      create  waldo/bin/console
+      create  waldo/bin/setup
+      create  waldo/LICENSE.txt
+      create  waldo/CODE_OF_CONDUCT.md
+Initializing git repo in /waldo
+```
 
 ## Edit the gemspec file
 
+Modify the gemspec to your specifications
+
 ```
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
@@ -20,7 +54,7 @@ Gem::Specification.new do |spec|
   spec.name          = "waldo"
   spec.version       = Waldo::VERSION
   spec.authors       = ["Austin Trout"]
-  spec.email         = ["trouta23@gmail.com"]
+  spec.email         = ["[trouta23@gmail.com]"]
 
   spec.summary       = %q{Waldo is used to learn about making your own gem}
   spec.homepage      = "https://github.com/trouta23/waldo"
@@ -53,19 +87,25 @@ end
 
 ## Add your code
 
-## Deploy to GitHub
+For example, in `lib/waldo.rb`:
 
-## Bundle Local Gemfile
+```ruby
+require "waldo/version"
 
-`bundle install`
+module Waldo
+  def self.where_are_you
+    puts "It's a secret!"
+  end
+end
+```
 
-## Generate and Deploy to RubyGems.org
+## Deploy to GitHub
 
-`bundle exec rake release`
+Create a new repo, and follow the steps to push to the new GitHub repo.
 
----
+The exact steps to do so are not in this tutorial.
 
-# What you'll initially see when you initially make your gem
+This is what you'll see initially:
 
 ---
 
@@ -105,7 +145,94 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/waldo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+---
+
+# Testing out your new gem
+
+## Build your gem
+
+```
+$ gem build waldo.gemspec
+
+Successfully built RubyGem
+Name: waldo
+Version: 0.1.0
+File: waldo-0.1.0.gem
+```
+
+## Install your gem
+
+You'll want to base it off your File name seen in the gemspec
+
+```
+$ gem install ./waldo-0.1.0.gem
+
+Successfully installed waldo-0.1.0
+Parsing documentation for waldo-0.1.0
+Installing ri documentation for waldo-0.1.0
+Done installing documentation for waldo after 0 seconds
+1 gem installed
+```
+
+## Test it in irb
+
+```
+$ irb
+
+>> require 'waldo'
+=> true
+>> Waldo.where_are_you
+It's a secret!
+```
+
+# Cutting a release
+
+## Setup RubyGems API access
+
+On your RubyGems profile, go to the edit view and down under the API ACCESS section you'll see a version of the command below:
+
+    $ curl -u {username} https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
+
+Run this command as this will give you access to gem commands from the command line.
+Located here: http://guides.rubygems.org/command-reference/
+
+When you run this command you'll get prompted for your key which will also be located under API ACCESS and say:
+
+`Your API key is {your_key_here}.`
+
+## Bundle local gemfile
+
+```
+$ bundle install
+
+Fetching gem metadata from https://rubygems.org/
+Fetching version metadata from https://rubygems.org/
+Resolving dependencies...
+Installing rake 10.5.0
+Using bundler 1.12.5
+Using waldo 0.1.0 from source at `.`
+Bundle complete! 3 Gemfile dependencies, 3 gems now installed.
+Use `bundle show [gemname]` to see where a bundled gem is installed.
+```
+
+## Generate and deploy to RubyGems.org
+
+```
+$ bundle exec rake release
+
+waldo 0.1.0 built to pkg/waldo-0.1.0.gem.
+Tagged v0.1.0.
+Pushed git commits and tags.
+Pushed waldo 0.1.0 to rubygems.org.
+```
+
+# You're officially good to go!
+
+Go check out your new gem on RubyGems.org!
+
+As more details are found that would be useful and not too advanced they'll be added
+to the repo. Also feel free to submit your own!

data/lib/waldo.rb

@@ -1,7 +1,7 @@
 require "waldo/version"
 
 module Waldo
-  def self.hi
-    puts "Hello world!"
+  def self.where_are_you
+    puts "It's a secret!"
   end
 end

data/lib/waldo/version.rb

@@ -1,3 +1,3 @@
 module Waldo
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waldo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Austin Trout