hack_cards 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a931c27713f512445979f13cbee76e215aaaa9f1
-  data.tar.gz: 70a9fb09c865d365a8468b99620a12e144930518
+  metadata.gz: 35a0dc7eefbf40ce1b79c70f71e526708f6becc6
+  data.tar.gz: 0dad31a3f91f1765ef90eaa2f2476dfb74964576
 SHA512:
-  metadata.gz: dda06fbdc31e24e59629a50dfaa01004ab9282cb2c13e31e475caa9a28754023c312014741aee260264b9e8088ee9197359c6baf93203ab8b0efe28ac6567008
-  data.tar.gz: c689525689a97c4a463c99d918966a8aec0296ac8580db7c898c15da7ed97ada08a2caaea9bf6761151abe061a117df471688bfb0128f3e6ad48f3f1aa803498
+  metadata.gz: b4c3cf866a7432acda3e300ebda673caa1f0b0607e1f6accdf8dbedeec394cbaefd19fb413a942a49ef7fdc1eb4dcecd259ce89aefebd1d44946b3abea7b0920
+  data.tar.gz: 3027655e520e658d00ddc3fffb86f7d18cfccb9cdf2d989ede82a97b62d957d6b4743dd37a0f5c19c63d4a0139e9edc1ff29c53a9a790bfc6bc9d61f8cdd45d6

data/README.md

@@ -1,13 +1,15 @@
 # Cards
 
-TODO: Write a gem description
+This is the first gem I have created.  Its goal is to create a platform for
+designing 'cards' that can contain different media objects and know how to
+display themselves.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cards'
+gem 'hack_cards'
 ```
 
 And then execute:
@@ -16,7 +18,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install cards
+    $ gem install hack_cards
 
 ## Usage
 
@@ -24,7 +26,7 @@ TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/cards/fork )
+1. Fork it ( https://github.com/michaelbyrd/cards/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`)

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rdoc/task"
 
 Rake::TestTask.new do |t|
   t.libs << "test"
@@ -7,4 +8,9 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib   /*.rb")
+end
+
 task default: :test

data/lib/hack_cards/version.rb

@@ -1,3 +1,3 @@
 module HackCards
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/hack_cards.rb

@@ -1,8 +1,17 @@
 require "hack_cards/version"
 
+# This is Documentation for the file itself
+
+# This is gem level documentation
 module HackCards
+
+  # This is class level documentation
   class Card
+
+    # text, url, and image are readable and writable fields
     attr_accessor :text, :url, :image
+
+    # this is documentation for the initialize method
     def initialize(image: "", text: "", url: "")
       @image = image if image.length > 0
       @text = text if text.length > 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hack_cards
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - MichaelByrd