Release 1.1.7

vpeschenkov · Mar 2, 2019 · f2d1453 · f2d1453
1 parent f80e2d7
commit f2d1453
Show file tree

Hide file tree

Showing 27 changed files with 209 additions and 138 deletions.
diff --git a/LetterAvatarKit.podspec b/LetterAvatarKit.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |spec|
   spec.name             = 'LetterAvatarKit'
   spec.platform         = :ios, '8.0'
-  spec.version          = '1.1.6'
+  spec.version          = '1.1.7'
   spec.license          = { :type => 'MIT' }
   spec.homepage         = 'https://github.com/vpeschenkov/LetterAvatarKit'
   spec.authors          = { 'Viktor Peschenkov' => 'v.peschenkov@gmail.com' }

diff --git a/LetterAvatarKit/Info.plist b/LetterAvatarKit/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.1.6</string>
+	<string>1.1.7</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>

diff --git a/LetterAvatarKitExample/Podfile.lock b/LetterAvatarKitExample/Podfile.lock
@@ -1,5 +1,5 @@
 PODS:
-  - LetterAvatarKit (1.1.5)
+  - LetterAvatarKit (1.1.7)
 
 DEPENDENCIES:
   - LetterAvatarKit (from `../`)
@@ -9,7 +9,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  LetterAvatarKit: a96090fe45f99c2fec661c45260016f4667e5fb8
+  LetterAvatarKit: ec7c18ff8c35a522d329d120bd5fb4e9f29c1091
 
 PODFILE CHECKSUM: 407d67c5c51bb4907e98b407342cb20aaddc7148
 

diff --git a/LetterAvatarKitExample/Pods/Local Podspecs/LetterAvatarKit.podspec.json b/LetterAvatarKitExample/Pods/Local Podspecs/LetterAvatarKit.podspec.json
diff --git a/LetterAvatarKitExample/Pods/Manifest.lock b/LetterAvatarKitExample/Pods/Manifest.lock
diff --git a/LetterAvatarKitExample/Pods/Target Support Files/LetterAvatarKit/Info.plist b/LetterAvatarKitExample/Pods/Target Support Files/LetterAvatarKit/Info.plist
diff --git a/LetterAvatarKitObjcExample/Podfile.lock b/LetterAvatarKitObjcExample/Podfile.lock
@@ -1,5 +1,5 @@
 PODS:
-  - LetterAvatarKit (1.1.6)
+  - LetterAvatarKit (1.1.7)
 
 DEPENDENCIES:
   - LetterAvatarKit (from `../`)
@@ -9,7 +9,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  LetterAvatarKit: 8e10f84349688c5b04ee03b72507a2e08739010b
+  LetterAvatarKit: ec7c18ff8c35a522d329d120bd5fb4e9f29c1091
 
 PODFILE CHECKSUM: acab86cc8cc5517bd2b945abae924096efac0c35
 

diff --git a/LetterAvatarKitObjcExample/Pods/Local Podspecs/LetterAvatarKit.podspec.json b/LetterAvatarKitObjcExample/Pods/Local Podspecs/LetterAvatarKit.podspec.json
diff --git a/LetterAvatarKitObjcExample/Pods/Manifest.lock b/LetterAvatarKitObjcExample/Pods/Manifest.lock
diff --git a/LetterAvatarKitObjcExample/Pods/Target Support Files/LetterAvatarKit/Info.plist b/LetterAvatarKitObjcExample/Pods/Target Support Files/LetterAvatarKit/Info.plist
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ![][Platform] ![][Travis] ![][Pods] ![][Swift Version] ![][Codacy Badge]
 
-LetterAvatarKit is an ```UIImage``` extension that generates letter-based avatars. Here are some images showing what LetterAvatarKit does:
+`LetterAvatarKit` provides an ```UIImage``` extension for generating letter-based avatars. There are a few images showing what you can achive by using this framework:
 
 ![][screenshots]
 
@@ -14,15 +14,43 @@ LetterAvatarKit is an ```UIImage``` extension that generates letter-based avatar
 
 ### CocoaPods
 
-To install LetterAvatarKit using CocoaPods, add this line to your Podfile:
+To install `LetterAvatarKit` using `CocoaPods`, add this line to your `Podfile`:
 ```ruby
-pod "LetterAvatarKit", "1.1.6" # Swift 4.2
+pod "LetterAvatarKit", "1.1.7" # Swift 4.2
 pod "LetterAvatarKit", "1.1.5" # Swift 4.0
 ```
 
 ## Usage
 
-You can configure the following properties of LetterAvatarBuilderConfiguration:
+### Swift
+
+By `LetterAvatarBuilderConfiguration`:
+```swift
+let configuration = LetterAvatarBuilderConfiguration()
+configuration.username = "Letter Avatar"
+avatarImageView?.image = UIImage.makeLetterAvatar(withConfiguration: configuration)
+```
+or simplier without the one:
+```swift
+avatarImageView?.image = UIImage.makeLetterAvatar(withUsername: "Letter Avatar")
+```
+
+### Objective-C
+
+Using a configuration:
+```objc
+LAKLetterAvatarBuilderCongiguration *configuration = [[LAKLetterAvatarBuilderCongiguration alloc] init];
+configuration.username = @"Letter Avatar";
+self.avatarImageView.image = [UIImage lak_makeLetterAvatarWithConfiguration:configuration];
+```
+or simplier without the one:
+```objc
+self.avatarImageView.image = [UIImage lak_makeLetterAvatarWithUsername:@"Letter Avatar"];
+```
+
+## Customization
+
+You can configure the following properties of `LetterAvatarBuilderConfiguration`:
 
 ```swift
 /// The size of an avatar image.
@@ -54,35 +82,14 @@ open var lettersColor: UIColor = LAKUIColorByRGB(red: 236, green: 240, blue: 241
 open var backgroundColors: [UIColor] = UIColor.colors
 ```
 
-### Swift
-
-Using a configuration:
 ```swift
-let configuration = LetterAvatarBuilderConfiguration()
-configuration.username = "Letter Avatar"
-avatarImageView?.image = UIImage.makeLetterAvatar(withConfiguration: configuration)
-```
-or
-```swift
-avatarImageView?.image = UIImage.makeLetterAvatar(withUsername: "Letter Avatar")
-```
-
-### Objective-C
-
-Using a configuration:
-```objc
-LAKLetterAvatarBuilderCongiguration *configuration = [[LAKLetterAvatarBuilderCongiguration alloc] init];
-configuration.username = @"Letter Avatar";
-self.avatarImageView.image = [UIImage lak_makeLetterAvatarWithConfiguration:configuration];
-```
-or
-```objc
-self.avatarImageView.image = [UIImage lak_makeLetterAvatarWithUsername:@"Letter Avatar"];
+/// The letters font attributes.
+open var lettersFontAttributes: [NSAttributedString.Key: Any]?
 ```
 
 ## Community
 
-Questions, comments, issues, and pull requests are always welcome!
+Questions, comments, issues, and pull requests are welcome!
 
 ## Contacts
 

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -126,7 +126,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-02)</p>
+          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-03)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/LetterAvatarBuilder.html b/docs/Classes/LetterAvatarBuilder.html
@@ -70,8 +70,8 @@ <h1>LetterAvatarBuilder</h1>
                   <div>
                     <code>
                     <a name="/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilder(im)makeAvatarWithConfiguration:"></a>
-                    <a name="//apple_ref/swift/Method/makeAvatar(withConfiguration:)" class="dashAnchor"></a>
-                    <a class="token" href="#/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilder(im)makeAvatarWithConfiguration:">makeAvatar(withConfiguration:)</a>
+                    <a name="//apple_ref/swift/Method/makeAvatar(with:)" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilder(im)makeAvatarWithConfiguration:">makeAvatar(with:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -87,7 +87,7 @@ <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
                           <pre class="highlight swift"><code><span class="kd">@objc(makeAvatarWithConfiguration:)</span>
-<span class="kd">open</span> <span class="kd">func</span> <span class="nf">makeAvatar</span><span class="p">(</span><span class="n">withConfiguration</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/LetterAvatarBuilderConfiguration.html">LetterAvatarBuilderConfiguration</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">UIImage</span><span class="p">?</span></code></pre>
+<span class="kd">open</span> <span class="kd">func</span> <span class="nf">makeAvatar</span><span class="p">(</span><span class="n">with</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/LetterAvatarBuilderConfiguration.html">LetterAvatarBuilderConfiguration</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">UIImage</span><span class="p">?</span></code></pre>
 
                         </div>
                       </div>
@@ -123,7 +123,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-02)</p>
+          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-03)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Classes/LetterAvatarBuilderConfiguration.html b/docs/Classes/LetterAvatarBuilderConfiguration.html
@@ -171,7 +171,7 @@ <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
                           <pre class="highlight swift"><code><span class="kd">@objc(lettersFont)</span>
-<span class="kd">open</span> <span class="k">var</span> <span class="nv">lettersFont</span><span class="p">:</span> <span class="kt">UIFont</span></code></pre>
+<span class="kd">open</span> <span class="k">var</span> <span class="nv">lettersFont</span><span class="p">:</span> <span class="kt">UIFont</span><span class="p">?</span></code></pre>
 
                         </div>
                       </div>
@@ -229,6 +229,34 @@ <h4>Declaration</h4>
                           <pre class="highlight swift"><code><span class="kd">@objc(backgroundColors)</span>
 <span class="kd">open</span> <span class="k">var</span> <span class="nv">backgroundColors</span><span class="p">:</span> <span class="p">[</span><span class="kt">UIColor</span><span class="p">]</span></code></pre>
 
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilderConfiguration(py)lettersFontAttributes"></a>
+                    <a name="//apple_ref/swift/Property/lettersFontAttributes" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilderConfiguration(py)lettersFontAttributes">lettersFontAttributes</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>The letters font attributes.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">@objc(lettersFontAttributes)</span>
+<span class="kd">open</span> <span class="k">var</span> <span class="nv">lettersFontAttributes</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSAttributedString</span><span class="o">.</span><span class="kt">Key</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?</span></code></pre>
+
                         </div>
                       </div>
                     </section>
@@ -239,7 +267,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-02)</p>
+          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-03)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Extensions.html b/docs/Extensions.html
@@ -91,7 +91,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-02)</p>
+          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-03)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/Extensions/UIImage.html b/docs/Extensions/UIImage.html
@@ -239,7 +239,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-02)</p>
+          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-03)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/docs/docsets/LetterAvatarKit.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/LetterAvatarKit.docset/Contents/Resources/Documents/Classes.html
@@ -126,7 +126,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-02)</p>
+          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-03)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>

diff --git a/...sets/LetterAvatarKit.docset/Contents/Resources/Documents/Classes/LetterAvatarBuilder.html b/...sets/LetterAvatarKit.docset/Contents/Resources/Documents/Classes/LetterAvatarBuilder.html
@@ -70,8 +70,8 @@ <h1>LetterAvatarBuilder</h1>
                   <div>
                     <code>
                     <a name="/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilder(im)makeAvatarWithConfiguration:"></a>
-                    <a name="//apple_ref/swift/Method/makeAvatar(withConfiguration:)" class="dashAnchor"></a>
-                    <a class="token" href="#/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilder(im)makeAvatarWithConfiguration:">makeAvatar(withConfiguration:)</a>
+                    <a name="//apple_ref/swift/Method/makeAvatar(with:)" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@LetterAvatarKit@objc(cs)LAKLetterAvatarBuilder(im)makeAvatarWithConfiguration:">makeAvatar(with:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -87,7 +87,7 @@ <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
                           <pre class="highlight swift"><code><span class="kd">@objc(makeAvatarWithConfiguration:)</span>
-<span class="kd">open</span> <span class="kd">func</span> <span class="nf">makeAvatar</span><span class="p">(</span><span class="n">withConfiguration</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/LetterAvatarBuilderConfiguration.html">LetterAvatarBuilderConfiguration</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">UIImage</span><span class="p">?</span></code></pre>
+<span class="kd">open</span> <span class="kd">func</span> <span class="nf">makeAvatar</span><span class="p">(</span><span class="n">with</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/LetterAvatarBuilderConfiguration.html">LetterAvatarBuilderConfiguration</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">UIImage</span><span class="p">?</span></code></pre>
 
                         </div>
                       </div>
@@ -123,7 +123,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-02)</p>
+          <p>&copy; 2019 <a class="link" href="hhttps://github.com/vpeschenkov" target="_blank" rel="external">Victor</a>. All rights reserved. (Last updated: 2019-03-03)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>