Merge pull request #1 from ksz2k/master

update from source

Merge pull request #1 from ksz2k/master
update from source
Hamad AlGhanim · GitHub
2 parents e1fd1546 ffae9239
Showing 3 changed files with 21 additions and 2 deletions Show diff stats
CHANGELOG.md
README.md
lib/letter_avatar/version.rb
+0.3.7
+-----
+
+- added `LetterAvatar.custom_palette` config option.
+- bumped `FULLSIZE` to 600.
+
 0.3.6
 -----
  
@@ -61,12 +61,23 @@ end
  
 #### Color palette
  
-We have two color palettes implemented: `iwanthue` and `google`.
+We have three color palettes implemented: `iwanthue`, `google` and `custom`.
  
 Each of them have different colors, but the `iwanthue` also differently calculates the color for specified username.
  
 The `google` selected will generate the same avatar for both, "Krzysiek" and "ksz2k" usernames given (both of them starts with letter "k"), but `iwanthue` will calculate it's md5 and then selects color, so there's huge chance that these usernames get different colors.
  
+##### Custom palette definition
+
+You can define your own `custom` palette:
+
+```ruby
+LetterAvatar.setup do |config|
+  config.colors_palette = :custom
+  config.custom_palette = [[120, 132, 205], [91, 149, 249], [72, 194, 249], [69, 208, 226]]
+end
+```
+
 ## Usage
  
 ```ruby
@@ -102,6 +113,8 @@ There&#39;s also helper for this. To use it, you need:
 Say, you have a model `User` (which must have attribute or method `name`)
  
 ```ruby
+require 'letter_avatar/has_avatar'
+
 class User
   include LetterAvatar::HasAvatar
   ...
 module LetterAvatar
-  VERSION = '0.3.6'
+  VERSION = '0.3.7'
 end
	1	+0.3.7
	2	+-----
	3	+
	4	+- added `LetterAvatar.custom_palette` config option.
	5	+- bumped `FULLSIZE` to 600.
	6	+
1	7	0.3.6
2	8	-----
3	9
...	...
...	...	@@ -61,12 +61,23 @@ end
61	61
62	62	#### Color palette
63	63
64		-We have two color palettes implemented: `iwanthue` and `google`.
	64	+We have three color palettes implemented: `iwanthue`, `google` and `custom`.
65	65
66	66	Each of them have different colors, but the `iwanthue` also differently calculates the color for specified username.
67	67
68	68	The `google` selected will generate the same avatar for both, "Krzysiek" and "ksz2k" usernames given (both of them starts with letter "k"), but `iwanthue` will calculate it's md5 and then selects color, so there's huge chance that these usernames get different colors.
69	69
	70	+##### Custom palette definition
	71	+
	72	+You can define your own `custom` palette:
	73	+
	74	+```ruby
	75	+LetterAvatar.setup do \|config\|
	76	+ config.colors_palette = :custom
	77	+ config.custom_palette = [[120, 132, 205], [91, 149, 249], [72, 194, 249], [69, 208, 226]]
	78	+end
	79	+```
	80	+
70	81	## Usage
71	82
72	83	```ruby
...	...	@@ -102,6 +113,8 @@ There's also helper for this. To use it, you need:
102	113	Say, you have a model `User` (which must have attribute or method `name`)
103	114
104	115	```ruby
	116	+require 'letter_avatar/has_avatar'
	117	+
105	118	class User
106	119	include LetterAvatar::HasAvatar
107	120	...
...	...
1	1	module LetterAvatar
2		- VERSION = '0.3.6'
	2	+ VERSION = '0.3.7'
3	3	end
...	...