README.md in gemsmith-2.2.0 vs README.md in gemsmith-2.3.0

- old
+ new

@@ -29,16 +29,16 @@ 3. [RubyGems](http://rubygems.org). 4. [Bundler](https://github.com/carlhuda/bundler). # Setup -Type the following from the command line to securely install (recommended): +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 -...or type the following to insecurely install (not recommended): +...or, for an insecure install, type the following (not recommended): gem install gemsmith You can configure common settings for future gem builds by creating the following file: @@ -69,16 +69,16 @@ # Usage From the command line, type: gemsmith help - gemsmith -c, [create=GEM_NAME] # Create new gem. - gemsmith -e, [edit] # Edit gem settings in default editor (assumes $EDITOR environment variable). - gemsmith -h, [help] # Show this message. - gemsmith -o, [open=NAME] # Opens gem in default editor (assumes $EDITOR environment variable). - gemsmith -r, [read=NAME] # Opens gem in default browser. - gemsmith -v, [version] # Show version. + gemsmith -c, [create=CREATE] # Create new gem. + gemsmith -e, [edit] # Edit gem in default editor (assumes $EDITOR environment variable). + gemsmith -h, [--help=HELP] # Show this message or get help for a command. + gemsmith -o, [open=OPEN] # Open gem in default editor (assumes $EDITOR environment variable). + 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. @@ -91,23 +91,36 @@ -t, [--travis] # Add Travis CI support. # Default: true -c, [--code-climate] # Add Code Climate support. # Default: true -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): +Once a gem skeleton has been created, the following tasks are available within the project 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 + 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 + rake release # Create tag v2.3.0 and build and push example-0.1.0.gem to Rubygems # Tests To test, do the following: 0. cd to the gem root. 0. bundle install 0. bundle exec rspec spec + +# Security + +To creat a certificate for your gems, run the following: + + cd ~/.ssh + gem cert --build you@example.com + chmod 600 gem-*.pem + +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) +* [A Practical Guide to Using Signed Ruby Gems - Part 2: Heroku](http://blog.meldium.com/home/2013/3/6/signed-gems-on-heroku) # Best Practices 0. [Semantic Versioning](http://semver.org) 0. [Best Practices While Cutting Gems](http://rubysource.com/crafting-rubies-best-practices-while-cutting-gems).