README.md in version_info-0.7.1 vs README.md in version_info-1.0.0
- old
+ new
@@ -19,25 +19,26 @@
module MyProject
include VersionInfo
end
-From here, is better to use the builtin rake/thor tasks (see it fordward). Here is how VersionInfo works and their user options:
+From here, is better to use the builtin rake/thor tasks (see it forward). Here is how VersionInfo works and their user options:
-After you included VersionIinfo, a new class MyProject::Version is defined (it inherit from VersionIinfo::Data). Also a new constant MyProject::VERSION is created holding an object of class MyProject::VersionIinfo.
+After you included VersionIinfo, a new constant MyProject::VERSION is created holding an object of class VersionInfo::Data
VersionInfo use yaml file to store version data:
---
major: 0
minor: 1
patch: 0
author: jcangas
-By default the file is named version_info.yml and stored near the main file with the include VersionIinfo thing.
+By default the file is named version_info.yml and stored in the current dir, useful
+when using Rake or Thor.
-Anyway, you can change this:
+Anyway, you can change this (recomended):
module MyProject
include VersionInfo
VERISION.file_name = '/path/to/my_file.yaml'
end
@@ -82,11 +83,11 @@
rake vinfo:major # Bumps version segment MAJOR
rake vinfo:minor # Bumps version segment MINOR
rake vinfo:patch # Bumps version segment PATCH
rake vinfo:show # Show current version tag and create version_info.yml if missing
-Or, if you prefer Thor:
+If you prefer Thor:
VersionInfo::ThorTasks.install(:class => MyProject) # use the thing where you included VersionInfo
thor list
=>
@@ -96,8 +97,10 @@
thor vinfo:bump SEGMENT=patch # bumps segment: [major, minor, patch, build]...
thor vinfo:inspect # Show complete version info
thor vinfo:show # Show version tag and create version_info.yml...
### Install
+
+ VersionInfo is [https://rubygems.org/gems/version_info](https://rubygems.org/gems/version_info) at so:
gem install version_info