rubenum 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7cf05cb7fbb00f4b92af49a1d9f217b8214221288c895c9ab3c5f7bcc616386
-  data.tar.gz: a239697d833132e9d93830527610c3b02fe83750f00e8e7d4dd5b94e65979248
+  metadata.gz: 061f383d10f635d645558b3687ccdf3fb2f8ba506a97f139b0522da9448c52fb
+  data.tar.gz: 672eac3c62691e1a83f58246909a70c13396150bf9f9b1b2019c054e792f8bc9
 SHA512:
-  metadata.gz: 8ea675efc270202e3a61f6cb7ee551ea2ad30c04769c150eaecbd1993657385b0624d254b9357c53623716feeb04edacd6703d5f56a12ce59c3dd7cce28794d0
-  data.tar.gz: 1c6b87567a2a1cccc0b08503663dd74223e3ce146220fa2e4973b8f88914e0d37d88a05ad2bac8746c715ce58d6dcf55a958a2b2553e08ee5eef833bd4940cf0
+  metadata.gz: 46ea4101ab8079d5e1a5582575c9babc42edbec332ddec5f09e79882b705ee4720c6c00cf479407eda498ef67a9cd0ed465df23ed0f3eebbce400e34f6f73184
+  data.tar.gz: 8cf40f30d6ca4d5a13f04b4506ce6739d18db5fc1d443675381d70d4aaa3a7b64ef3031510b5f14f84267de4c424faacade5ae6a45a0c90db58c275a12a3cdb1

data/README.md

@@ -1,15 +1,21 @@
 # Rubenum
 
-Enum implementation for Ruby.
+Rubenum allows you to create simple enumerations in Ruby.
 
-Create an enum from an array of strings with `Rubenum.new`.  
+## Installation
+
+You can install the Rubenum gem via `gem install rubenum`.
+
+## Usage
+
+Create an enumeration from an array of strings with `Rubenum.new`.  
 Only valid Ruby identifiers are accepted.  
-Every element will be capitalized in order to make them Ruby constants.
+By default, every element will be capitalized in order to make valid Ruby constant identifiers.
 
 ### Arguments
- - elements (array of string) : array containing the elements of the enum
- - upcase (boolean optional default:false) : true to upcase elements instead of capitalize them
- - binary_values (boolean optional default:false) : true to use binary values (1 2 4 8 16 ...) instead of incremental values (1 2 3 4 5 ...)
+ - elements (array of string) : array containing the elements of the enumeration
+ - upcase (optional boolean (default:false)) : true => upcase elements' name instead of capitalizing them
+ - binary_values (optional boolean (default:false)) : true => use binary values (1 2 4 8 16 ...) instead of incremental values (1 2 3 4 5 ...)
 
 ### Example
 	e = Rubenum.new(%w[red orange green])

data/lib/rubenum.rb

@@ -1,13 +1,13 @@
-# Enum implementation for Ruby.
+# Rubenum allows you to create simple enumerations in Ruby.
 module Rubenum
-	# Create an enum from an array of strings.
-	# Only valid Ruby identifiers are accepted.
-	# Every element will be capitalized in order to make them Ruby constants.
+	# Create an enumeration from an array of strings with `Rubenum.new`.  
+	# Only valid Ruby identifiers are accepted.  
+	# By default, every element will be capitalized in order to make valid Ruby constant identifiers.
 	#
 	# Arguments :
-	#  - elements (array of string) : array containing the elements of the enum
-	#  - upcase (boolean optional default:false) : true to upcase elements instead of capitalize them
-	#  - binary_values (boolean optional default:false) : true to use binary values(1 2 4 8 16 ...) instead of incremental values (1 2 3 4 5 ...)
+	# - elements (array of string) : array containing the elements of the enumeration
+	# - upcase (optional boolean (default:false)) : true => upcase elements' name instead of capitalizing them
+	# - binary_values (optional boolean (default:false)) : true => use binary values (1 2 4 8 16 ...) instead of incremental values (1 2 3 4 5 ...)
 	#
 	# Example :
 	#     e = Rubenum.new(%w[red orange green])

data/rubenum.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 	s.name    = 'rubenum'
-	s.version = '1.0.0'
-	s.summary = "Enum implementation for Ruby."
+	s.version = '1.0.1'
+	s.summary = "Rubenum allows you to create simple enumerations in Ruby."
 	s.author  = 'Jérémy Blain'
 	s.files   = Dir['lib/**/*'] + Dir['test/**/*']
 	s.files  += ['LICENSE', 'README.md', 'Rakefile', 'rubenum.gemspec']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubenum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jérémy Blain
@@ -46,5 +46,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Enum implementation for Ruby.
+summary: Rubenum allows you to create simple enumerations in Ruby.
 test_files: []