README.rdoc in gemsmith-0.1.0 vs README.rdoc in gemsmith-0.2.0
- old
+ new
@@ -4,16 +4,21 @@
of Bundler[https://github.com/carlhuda/bundler] and appreciate the quick and easy setup you get via the +bundle gem+
command then you'll enjoy this gem since it is essentially an enhanced version of Bundler.
= Features
-* Common custom settings that you can configure once and use for every new gem that you build.
-* Additional skeleton files such as a README, CHANGELOG, and LICENCE (which you pretty much always need).
+* Builds a gem skeleton with Bundler functionality in mind.
+* Allows for common settings that you can configure once and use for every new gem that you build.
+* Supports binary skeletons with Thor[https://github.com/wycats/thor] command line functionality.
+* Supports {Ruby on Rails}[http://rubyonrails.org] skeletons.
+* Supports RSpec[http://rspec.info] test skeletons.
+* Adds commonly needed README, CHANGELOG, LICENSE, etc. template files.
= Requirements
-* A desire to develop professional gems.
+* Bundler[https://github.com/carlhuda/bundler]
+* Basic familiarity with gem building.
= Setup
Type the following from the command line to install:
@@ -32,30 +37,40 @@
:author_email: brooke@redalchemist.com
:author_url: http://www.redalchemist.com
:company_name: Red Alchmist
:company_url: http://www.redalchemist.com
-NOTE: All of the options above are optional. You don't have to create the setting.yml at all or you can pick and
-choose what you want to define. Up to you. If you don't specify any settings then everything defaults as follows:
+NOTE: All options above are optional. You don't have to create the setting.yml at all or you can pick and
+choose what options to define. Up to you. If no options are configured, then the default options are as follows:
gem_platform: Gem::Platform::RUBY
author_name: <git user name>
author_email: <git email>
author_url: nil
company_name: <author name>
company_url: <author URL>
= Usage
-From the command line, type: tweeter help
+From the command line, type: gemsmith help
gemsmith -c, [create=GEM_NAME] # Create new gem.
gemsmith -h, [help] # Show this message.
gemsmith -v, [version] # Show version.
-For more gem creation options, type: tweeter help create
+For more gem creation options, type: gemsmith help create
- -b, [--bin] # Add binary to gem build.
+ -r, [--rspec] # Add RSpec support.
+ # Default: true
+ -b, [--bin] # Adds binary support.
+ -R, [--rails] # Adds Rails support.
+
+Also, don't forget that once you have created your gem skeleton, the following rake tasks are also
+available to you via Bundler (i.e. rake -T):
+
+ rake build # Build <gem>-<version>.gem into the pkg directory
+ rake install # Build and install <gem>-<version>.gem into system gems
+ rake release # Create tag v0.1.1 and build and push <gem>-<version>.gem to Rubygems
= Author
{Red Alchemist}[http://www.redalchemist.com]