README.md in version_info-0.6.2 vs README.md in version_info-0.6.3
- old
+ new
@@ -1,5 +1,7 @@
+## VersionInfo
+
### Overview
VersionIinfo is a powerful and very lightweight gem to manage version data in your Ruby projects or other gems.
VersionIinfo can manage a serie of predefined segments to build your version tag with the tipical structure X.X.X.X.
The values are stored in a yaml file, and supports custom values. Also, rake tasks are avaiable to simplify yaml file
@@ -17,19 +19,28 @@
module MyProject
include VersionInfo
end
-Create a file to store your version data. By default the file is named version_info.yml:
+From here, is better to use the builtin rake tasks (see it fordward). Here is how VersionInfo works and their user options:
+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.
+Anyway, you can change this:
+ module MyProject
+ include VersionInfo
+ VERISION.file_name = '/path/to/my_file.yaml'
+ end
+
Note you can put any custom data. In order to get the version tag, VersionInfo reserve some special keys
for use as the "segments" of the version tag:
module VersionInfo
@@ -60,19 +71,22 @@
Put in your rake file:
VersionInfo::Tasks.install(MyProject) # pass here the thing where you included VersionInfo
-And you get a few tasks within namespace vinfo:
+And you get a few tasks with a namespace vinfo:
rake -T
=>
rake vinfo:build # Bumps version segment BUILD
+ rake vinfo:inspect # Inspect all current version keys
rake vinfo:major # Bumps version segment MAJOR
rake vinfo:minor # Bumps version segment MINOR
rake vinfo:patch # Bumps version segment PATCH
rake vinfo:pre # Bumps version segment PRE
rake vinfo:show # Show current version tag and create version_info.yml if missing
+
+Note vinfo:inspect allows you check your custom keys also.
### Install
gem install version_info