suggest_username 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eeeb3b14ae9f45d00f0ff72541eff403ddf1dbe
-  data.tar.gz: 97c3f867b22f8d72f88e2db04e6ddfa386f6beda
+  metadata.gz: 38fe95767cf62cbfe450115a1917065550613e4f
+  data.tar.gz: fe35b6e408b1e7dea03186c279808edbd732cbb0
 SHA512:
-  metadata.gz: af3532e8473f32a0ba32662606214e92960e8050f9017b41423c20538aa13e02823b26587d2d1acdc0a0700110f1366e8bdeaf2adb44fdcc4321885822124960
-  data.tar.gz: ddd8637508f0110a3cfa066afae7e18d3b884a5ad02c98cc04826460dbf564c045452306f65c38ee13a85f734ecb2382e7131dea614d33ab070a1042d9279aa9
+  metadata.gz: be1915ff8409980286b539bf0ed343cbdf609d238bc10ae53e7f76a57df3f9805fa97c7bd86beade8d74bad41ce65b6876e14f32435d1a9e74b48687be884ec3
+  data.tar.gz: 83410db707b53c7e3e72f4052a4462955399977625cea3b7ddcf72141409d564c7732067b62c33925dedbff5b9e1d580cd585ac60424c4652f7e5959b410ebbc

data/lib/suggest_username.rb

@@ -1,4 +1,16 @@
 class SuggestUserName
+  # It generates username suggestions for users. It generate on the basis of first_name and last_name is optional 
+  # UsernameSuggester
+  # require "suggest_username"
+  # 
+  # Example:
+  #   create a object with first_name ane last_name as a parameters. here last_name is optional
+  #   user = SuggestUserName.new("test","demo")
+  #     
+  #  to get username suggestion call suggest methods
+  #  user.suggest(:exclude=>"abc",:number_of_suggestions=>5) 
+  #  
+  #  :exclude will exclude those username and second param :number_of_suggestions is for number of suggestions 
   attr_reader :first_name, :last_name
 
   def initialize(first_name, last_name=nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suggest_username
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Vijay Chouhan