README.rdoc in gemsmith-0.3.0 vs README.rdoc in gemsmith-0.4.0
- old
+ new
@@ -1,10 +1,10 @@
= Overview
-Gemsmith allows you to easily craft new gems via the command line with custom settings (if desired). If you are a fan
-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.
+Gemsmith allows you to easily craft new gems via the command line with custom settings (if desired). If you are
+a fan of Bundler[https://github.com/carlhuda/bundler], then you'll appreciate the quick and easy setup. Gemsmith
+is essentially an enhanced version of Bundler's gem building capabilities.
= Features
* 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.
@@ -22,12 +22,11 @@
Type the following from the command line to install:
gem install gemsmith
-You can also configure common custom settings that you would like to apply to all new gems that you build. To do this,
-simply create the following file:
+You can also configure common settings for future gem builds by creating the following file:
~/.gemsmith/settings.yml
...with the following settings (for example):
@@ -37,12 +36,11 @@
:author_email: brooke@redalchemist.com
:author_url: http://www.redalchemist.com
:company_name: Red Alchmist
:company_url: http://www.redalchemist.com
-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:
+NOTE: All options above are optional. If no options are configured, then the defaults are as follows:
gem_platform: Gem::Platform::RUBY
author_name: <git user name>
author_email: <git email>
author_url: nil
@@ -58,13 +56,13 @@
gemsmith -h, [help] # Show this message.
gemsmith -v, [version] # Show version.
For more gem creation options, type: gemsmith help create
- -r, [--rspec] # Add RSpec support.
+ -b, [--bin] # Add binary support.
+ -r, [--rails] # Add Rails support.
+ -s, [--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