README in echoe-4.4.1 vs README in echoe-4.5
- old
+ new
@@ -3,16 +3,12 @@
A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment.
== License
-Copyright 2007, 2008 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. Portions copyright 2006 Ryan Davis/Zen Spider Software and used with permission. See the included MIT-LICENSE file.
+Copyright 2007-2011 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. Portions copyright 2006 Ryan Davis/Zen Spider Software and used with permission. See the included MIT-LICENSE file.
-The public certificate for the gem is here[http://blog.evanweaver.com/files/evan_weaver-original-public_cert.pem].
-
-If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails.
-
== Features
* simple configuration
* comprehensive gem deployment
* cross-packaging
@@ -24,15 +20,13 @@
== Installation
Install the gem:
sudo gem install echoe
-
-If you haven't already, make sure Rubyforge is configured locally and your password is correctly set:
- rubyforge setup
- rubyforge config
+If you haven't already, make sure rubygems.org is configured locally and your password is correctly set.
+
== Project configuration
Organize your gem according to the usual structure:
lib/
@@ -44,22 +38,22 @@
You can add the <tt>bin/</tt> or <tt>ext/</tt> folders if you have executables or extensions, respectively.
Your <tt>CHANGELOG</tt> should be formatted as follows (including newlines):
v2.1. newest change
-
+
v2. older change
-
+
v1.9. oldest change
-
+
This way Echoe can parse the latest version and changeset message automatically.
Your <tt>Rakefile</tt> needs the following minimal contents:
- require 'echoe'
+ require 'echoe'
Echoe.new('gem_name')
-
+
More advanced configuration is described in the Echoe class.
== Deploying your gem
To deploy the gem and documentation:
@@ -92,17 +86,10 @@
* <tt>uninstall</tt> - Uninstall the gem.
Upload:
* <tt>publish_docs</tt> - Publish documentation to the web.
-* <tt>release</tt> - Package and upload the latest release to Rubyforge.
-* <tt>announce</tt> - Generate a release announcement, edit it, and post it to Rubyforge.
-
-Cleaning:
-
-* <tt>clean</tt> - Delete all the generated documentation and packages.
-* <tt>redocs</tt> - Force a rebuild of the Rdoc files.
-* <tt>repackage</tt> - Force a rebuild of the package files.
+* <tt>release</tt> - Package and upload the latest release to rubygems.org.
== Reporting problems
The support forum is here[http://github.com/fauna/echoe/issues].