Permalink
Browse files

Updated the README to reflect the additional Rails3 changes.

  • Loading branch information...
1 parent 8865626 commit 008b7a56f5e17100d03236c827deaf3ca448e4a9 @james2m committed Jul 11, 2011
Showing with 26 additions and 0 deletions.
  1. +26 −0 README.rdoc
View
@@ -12,6 +12,15 @@ Version is a simple wrapper around the concept of version-numbering schemes.
* Rake::VersionTask provides tasks for simple version bumping
* Version smartly handles several versioning schemes, abstracting the details
+* Version adds versioning to your Rails3 application
+
+== Installation
+
+=== Using Bundler?
+
+Add the following to your Gemfile
+
+ gem 'version'
== Examples
@@ -106,6 +115,23 @@ The Version.current and Class::is_versioned methods both take a filename
parameter if you use a different location for the VERSION file. See the
Version.current rdoc for details.
+=== Rails3 Versioning
+
+Version adds a VERSION to the applications namespace should you need to access
+the version information from within the application.
+
+So if your config/environment.rb looks like this;
+
+ # Load the rails application
+ require File.expand_path('../application', __FILE__)
+
+ # Initialize the rails application
+ Silverbug::Application.initialize!
+
+You can retrieve the current running version with;
+
+ Silverbug::VERSION
+
=== Manipulation in Code
All the above functionality is performed behind-the-scenes by the Version

0 comments on commit 008b7a5

Please sign in to comment.