fancy_version 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe7aae9e1a00fbce98e2798f2ecedf382d262d7
-  data.tar.gz: 6902f361025cdd72f61847606d5814b296132b48
+  metadata.gz: 03936597605c2c155ff6a183f7ece32b8d923e12
+  data.tar.gz: 32f79fcfd9f2d4e905d3427c1e07a0c77ed898f8
 SHA512:
-  metadata.gz: 8b3ca3b996b8e17586942a43a8f1f3bfc5d08e962ffdda6996c13c3ce252ecafe2fd1143c7ac67e1d57e22adb932a4c7ba35ffe61bd7a55b9ddaff28e821eed7
-  data.tar.gz: 368f973e0f0aa3acd408d3a4b37924b8fd947793e4d89f6ab6e4a1408285c07ccc3654c4e2988907ae517546c8e1fa20ffd1ecc140b5056a975a242fa43cd1e9
+  metadata.gz: 7ceece98375284ea452e690d5aa092bd47db7d0ad97d6c79ffde8ffd379dcf9f88e9fa668657e47e0e7f3ce47d01ae51782070b87b9ae5c7d850310c34358720
+  data.tar.gz: f4a5d02097331bd4679b5c3dc7b1fcfedbac074813317420b659ef0d6e89c7b62cf96a7dcdba7b3487d1e9b4c02991bbe2a8040d3abf0fb4a5e2c03b77f105be

data/README.md

@@ -1,6 +1,21 @@
 # FancyVersion
 
-An attempt to add style to your application version.
+An attempt to add style to your application's version.
+
+## Idea
+
+Alongside with the standard *major.minor.revision* format, generate a codename that will reflect the version. Like Ubuntu releases, each having a corresponding codename (Natty Narwhal, heh?).
+
+For example, let's take the standard version string apart:
+
+* **major version** — this changes rarely and a *noun* represents it well. After all, another major release of a software project is a completely different *being*.
+* **minor version** — this is a variation of a major release and could serve as indication of its maturity, so let's go with an adjective describing age, i.e. "newborn", "young", "adolescent", "adult", "elderly" etc.
+* **revision number** — this is a variation of a variation and could represent anything depending on the development/deployment process. For the example here, let's go with another adjective, like quality, i.e. "silly", "grumpy", "horrible".
+
+So, according to this scheme, version number `1.2.3` may be translated to something like 'Ape'.'Young'.'Horrible', or according to English grammar: `Horrible Young Ape`. Cool, huh?
+
+Another good idea is to use words starting with 'A' to represent number 1, 'B' - number 2 and so on. That's completely unnecessary, but adds some more coolness in my humble opinion.
+
 
 ## Installation
 
@@ -18,9 +33,22 @@ Or install it yourself as:
 
 ## Usage
 
-This goes into your `
+This usually goes into your `lib/my_app_name/version.rb`:
+
+```
+require "fancy_version"
+
+module MyAppName
+  VERSION = "1.2.3"
+  VERSION_CODENAME = FancyVersion.codename( VERSION ) # => "Horrible Young Ape"
+end
+```
+
+## TODO:
 
-TODO: Write usage instructions here
+- write comprehensive docs
+- add complete dictionary (or dictionaries)
+- provide methods/options to deal with versions starting with 0 (vs 1)
 
 ## Contributing
 

data/fancy_version.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["alex@kukushk.in"]
   spec.description   = %q{Generates a fancy codename reflecting your application's version}
   spec.summary       = %q{Generates a fancy codename reflecting your application's version}
-  spec.homepage      = ""
+  spec.homepage      = "http://github.com/kukushkin/fancy_version"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/fancy_version/version.rb

@@ -1,6 +1,6 @@
 require 'fancy_version/codename'
 
 module FancyVersion
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
   VERSION_CODENAME = FancyVersion.codename( VERSION )
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fancy_version
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-25 00:00:00.000000000 Z
+date: 2013-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,7 +54,7 @@ files:
 - lib/fancy_version.rb
 - lib/fancy_version/codename.rb
 - lib/fancy_version/version.rb
-homepage: ''
+homepage: http://github.com/kukushkin/fancy_version
 licenses:
 - MIT
 metadata: {}