README.md in gemsmith-2.4.0 vs README.md in gemsmith-3.0.0
- old
+ new
@@ -1,28 +1,33 @@
# Overview
[](http://badge.fury.io/rb/gemsmith)
[](https://codeclimate.com/github/bkuhlmann/gemsmith)
+[](https://gemnasium.com/bkuhlmann/gemsmith)
[](http://travis-ci.org/bkuhlmann/gemsmith)
+[](https://coveralls.io/r/bkuhlmann/gemsmith)
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 additional capabilities of this
gem. Gemsmith is essentially an enhanced version of Bundler's gem building capabilities.
# Features
* Builds a gem skeleton with Bundler functionality in mind.
* Supports common settings that can be applied to new gem creations.
-* Supports binary skeletons with [Thor](https://github.com/wycats/thor) command line functionality.
+* Supports [Thor](https://github.com/wycats/thor) command line functionality.
* Supports [Ruby on Rails](http://rubyonrails.org).
* Supports [RSpec](http://rspec.info).
* Supports [Pry](http://pryrepl.org).
* Supports [Guard](https://github.com/guard/guard).
* Supports [Code Climate](https://codeclimate.com).
-* Supports [Travis CI](http://travis-ci.org) skeletons.
-* Adds commonly needed README, CHANGELOG, LICENSE, etc. template files.
-* Provides the ability to open any installed gem within your favorite editor.
+* Supports [Gemnasium](https://gemnasium.com).
+* Supports [Travis CI](http://travis-ci.org).
+* Supports [Coveralls](https://coveralls.io).
+* Provides the ability to open the source code of any gem within your favorite editor.
+* Provides the ability to read the documentation of any gem within your default browser.
+* Adds commonly needed README, CHANGELOG, CONTRIBUTING, LICENSE, etc. template files.
# Requirements
0. A UNIX-based system.
0. Any of the following Ruby VMs:
@@ -35,11 +40,11 @@
# Setup
For a secure install, type the following from the command line (recommended):
gem cert --add <(curl -Ls http://www.redalchemist.com/gem-public.pem)
- gem install gemsmith -P HighSecurity
+ gem install gemsmith --trust-policy HighSecurity
...or, for an insecure install, type the following (not recommended):
gem install gemsmith
@@ -56,21 +61,23 @@
:company_name: Red Alchemist
If no options are configured, then the defaults are as follows:
gem_platform: Gem::Platform::RUBY
+ gem_private_key: ~/.ssh/gem-private.pem
+ gem_public_key: ~/.ssh/gem-public.pem
author_name: <git name>
author_email: <git email>
author_url: https://www.unknown.com
gem_url: <author URL>
company_name: <author name>
company_url: <author URL>
github_user: <github user>
year: <current year>
ruby_version: 2.0.0
ruby_patch: p0
- rails_version: 3.2.0
+ rails_version: 4.0
# Usage
From the command line, type: gemsmith help
@@ -81,22 +88,26 @@
gemsmith -r, [read=READ] # Open gem in default browser.
gemsmith -v, [--version] # Show version.
For more gem creation options, type: gemsmith help create
- -b, [--bin] # Add binary support.
- -r, [--rails] # Add Rails support.
- -p, [--pry] # Add Pry support.
- # Default: true
- -g, [--guard] # Add Guard support.
- # Default: true
- -s, [--rspec] # Add RSpec support.
- # Default: true
- -t, [--travis] # Add Travis CI support.
- # Default: true
- -c, [--code-climate] # Add Code Climate support.
- # Default: true
+ -b, [--bin], [--no-bin] # Add binary support.
+ -r, [--rails], [--no-rails] # Add Rails support.
+ -p, [--pry], [--no-pry] # Add Pry support.
+ # Default: true
+ -g, [--guard], [--no-guard] # Add Guard support.
+ # Default: true
+ -s, [--rspec], [--no-rspec] # Add RSpec support.
+ # Default: true
+ -c, [--code-climate], [--no-code-climate] # Add Code Climate support.
+ # Default: true
+ -G, [--gemnasium], [--no-gemnasium] # Add Gemnasium support.
+ # Default: true
+ -t, [--travis], [--no-travis] # Add Travis CI support.
+ # Default: true
+ -C, [--coveralls], [--no-coveralls] # Add Coveralls support.
+ # Default: true
Once a gem skeleton has been created, the following tasks are available within the project via Bundler (i.e. rake -T):
rake build # Build example-0.1.0.gem into the pkg directory
rake install # Build and install example-0.1.0.gem into system gems
@@ -110,14 +121,17 @@
0. bundle install
0. bundle exec rspec spec
# Security
-To creat a certificate for your gems, run the following:
+To create a certificate for your gems, run the following:
cd ~/.ssh
gem cert --build you@example.com
chmod 600 gem-*.pem
+
+The resulting *.pem keys can be referenced via the *gem_private_key* and *gem_public_key* settings mentioned in the
+Setup documentation.
To learn more about gem certificates, read the following:
* [Ruby Gems](http://guides.rubygems.org/security/#building_gems)
* [A Practical Guide to Using Signed Ruby Gems - Part 1: Bundler](http://blog.meldium.com/home/2013/3/3/signed-rubygems-part)