namazing 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36bb6d1773bb0d3157b93d5b1470d7038a791ebf
-  data.tar.gz: 3998947ff6c98ed1ca1ffb3111b5e2ed704b82af
+  metadata.gz: ee0f3661d5a46528c934aba1fc00a04bcdf35d26
+  data.tar.gz: dd5287fd0d6580234eb685816d6a9e37050ee182
 SHA512:
-  metadata.gz: b4dbe1dc80d2e67639a3776f3309c31231116bc6da21aab1f6ba0fab8f520c5136cadfbc00e33675809bb2946807a3afc97b840a467d0fffdf9883e57eeda600
-  data.tar.gz: bc4f39000543d576b6bb27fe0172c03d243024520483305ea6a433f3fdd19e17e61852261e4c8a10a6b74d55418ba76f9280a7ba7fb9d501db0d3cbdddde9ffe
+  metadata.gz: e7062a74916426f669b8162f665e2207972f11c517698e0bed2a548335cb18afbaab03c7135ca4519a608ee91053b7641e5bef6e6c5436f82942f7e6d651de16
+  data.tar.gz: d823727aef71ef2796ebccb2bd913af71a112198d70f37804eeae31b74136baabf847bc8bf40f842c2c6c285e82b8df4446abfabdec3f5eb23b15bfa8174e2e4

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,7 +1,62 @@
-Namazing
-===================
+# Namazing
 
 Name things with more awesome.
 
+## Installation
 
+Installing directly via Rubygems:
 
+    gem install namazing
+
+If you're using bundler, add this line to your Gemfile:
+
+    gem 'namazing'
+
+
+## Usage
+
+There are two main use cases for Namazing:
+
+1. Generating a random awesome word:
+
+    Namazing.random
+
+2. Making an existing word or string awesome:
+
+    Namazing.to_awesome "boring_word"
+
+
+## Persistance
+
+When using ````Namazing.to_awesome````, the awesome name that
+Namazing generates will be persistant. This means that you
+can call the function as many times as you wish and you
+will always get the same result.
+
+This persistance will apply when using multiple words. Namazing
+will split your words and will treat each word separately.
+
+### Example
+
+    Namazing.to_awesome "boring_yawn"
+    => "walkyrie_codetta"
+
+    Namazing.to_awesome "yawn_boring"
+    => "codetta_walkyrie"
+
+    Namazing.to_awesome "very_boring"
+    => "exaggerated_walkyrie"
+
+
+## Case
+
+Namazing understands case variations, particularly around
+camelCase, PascalCase and under_score. The result that
+Namazing will return will match the case that you provide.
+
+
+## Contributions
+
+Please feel free to create pull requests. I'm particularly
+interested in requests that improve the wordlist to maintain
+a high level of awesome and remove boring words.

data/lib/namazing/namazing.rb

@@ -1,5 +1,5 @@
 require 'digest'
-require './lib/namazing/wordup.rb'
+require_relative 'wordup'
 
 module Namazing
 
@@ -7,7 +7,7 @@ module Namazing
   WORDLIST_SIZE = WORDLIST.size
 
   def self.version
-    "0.0.2"
+    "0.0.3"
   end
 
   def self.random

data/lib/namazing.rb

@@ -1,4 +1,4 @@
-require './lib/namazing/namazing.rb'
+require 'namazing/namazing'
 
 module Namazing
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namazing
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dan Harper