Permalink
Browse files

README.md: updated verbiage and markdown, rencdec.gemspec: updated ve…

…rbiage
  • Loading branch information...
1 parent 45b2dbb commit d1afc7f26e6c890ac7dcf0a614a75b7dbcaf6232 @klappy committed Apr 13, 2012
Showing with 15 additions and 4 deletions.
  1. +12 −1 README.md
  2. +3 −3 rencdec.gemspec
View
@@ -1,8 +1,19 @@
## Purpose
-> Created to fill a need in supplying two arrays (a,b) of varying size and representing a third array (c) that uses items from the first array (a) and reversably encodes it into items from the second array (b) and returns the fourth array (d). Decoding using the same arrays should turn fourth array (d) into the third array (c). Examples include letters to numbers, musical notes to colors, or any other grouping of objects describable as an array words.
+Created to fill a need in supplying two arrays (a,b) of varying size and representing a third array (c) that uses items from the first array (a) and reversably encodes it into items from the second array (b) and returns the fourth array (d). Decoding using the same arrays should turn fourth array (d) into the third array (c). Examples include letters to numbers, musical notes to colors, or any other grouping of objects describable as an array of words.
+## Installation
[Install rencdec via rubygems and/or bundler](https://rubygems.org/gems/rencdec)
+### Rubygems
+```
+gem install rencdec
+```
+### Bundler
+
+```
+gem "rencdec", "~> 0.0.1"
+```
+## Examples
### Example A
Simple letters to numbers.
View
@@ -2,11 +2,11 @@ Gem::Specification.new do |s|
s.name = 'rencdec'
s.version = '0.0.1'
s.date = '2012-04-13'
- s.summary = 'Ruby encoder/decoder for arrays of arbitrary elements.'
- s.description = 'Created to fill a need in supplying two arrays (a,b) of varying size and representing a third array (c) that uses items from the first array (a) and reversably encodes it into items from the second array (b) and returns the fourth array (d). Decoding using the same arrays should turn fourth array (d) into the third array (c). Examples include letters to numbers, musical notes to colors, or any other grouping of objects describable as an array words.'
+ s.summary = 'Ruby encoder/decoder for arrays of arbitrary elements and for those with dislexia, not to be confused with redneck.'
+ s.description = 'Created to fill a need in supplying two arrays (a,b) of varying size and representing a third array (c) that uses items from the first array (a) and reversably encodes it into items from the second array (b) and returns the fourth array (d). Decoding using the same arrays should turn fourth array (d) into the third array (c). Examples include letters to numbers, musical notes to colors, or any other grouping of objects describable as an array of words.'
s.authors = ['klappy']
s.email = 'christopher@klapp.name'
s.files = Dir.glob("{bin,lib}/**/*") + %w(README.rdoc)
- s.homepage = 'https://github.com/klappy/rencdec'
+ s.homepage = 'http://klappy.github.com/rencdec/'
s.add_dependency('radix')
end

0 comments on commit d1afc7f

Please sign in to comment.