Merge pull request #8 from Fueled/documentation-updates

Documentation updates

.rubocop.yml

@@ -102,4 +102,4 @@ Layout/EndAlignment:
   AutoCorrect: true
 
 Lint/BooleanSymbol:
-  Enabled: false
+  Enabled: false

.yardopts

@@ -1 +1,4 @@
 --output-dir docs
+--readme README.md
+--no-private
+lib/ios_icon_generator/version.rb lib/ios_icon_generator.rb lib/ios_icon_generator/helpers/**/*.rb

README.md

@@ -33,7 +33,7 @@ For now, the CLI supports generating app icon sets for all supported platforms:
 - Mac
 - Carplay
 
-> Please note that the Display P3 is not supported yet
+> Please note that the Display P3 color space is not supported yet
 
 And supports generating sticker packs icons for iMessage apps.
 

docs/IOSIconGenerator.html

@@ -78,8 +78,8 @@
 
   <dl>
     <dt>Defined in:</dt>
-    <dd>lib/ios_icon_generator.rb<span class="defines">,<br />
-  lib/ios_icon_generator/helpers/generate_icon.rb,<br /> lib/ios_icon_generator/helpers/mask_icon.rb,<br /> lib/ios_icon_generator/helpers/which.rb</span>
+    <dd>lib/ios_icon_generator/version.rb<span class="defines">,<br />
+  lib/ios_icon_generator.rb,<br /> lib/ios_icon_generator/helpers/which.rb,<br /> lib/ios_icon_generator/helpers/mask_icon.rb,<br /> lib/ios_icon_generator/helpers/generate_icon.rb,<br /> lib/ios_icon_generator/helpers/image_sets_definition.rb</span>
 </dd>
   </dl>
 
@@ -88,7 +88,20 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
 
-<p>The IOSIconGenerator module</p>
+<p>Copyright © 2019 Fueled Digital Media, LLC</p>
+
+<p>Licensed under the Apache License, Version 2.0 (the “License”); you may not
+use this file except in compliance with the License. You may obtain a copy
+of the License at</p>
+
+<p><a
+href="http://www.apache.org/licenses/LICENSE-2.0">www.apache.org/licenses/LICENSE-2.0</a></p>
+
+<p>Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an “AS IS” BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.</p>
 
 
   </div>
@@ -100,13 +113,40 @@ <h2>Overview</h2><div class="docstring">
 <p class="children">
 
 
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="IOSIconGenerator/CLI.html" title="IOSIconGenerator::CLI (module)">CLI</a></span>, <span class='object_link'><a href="IOSIconGenerator/Helpers.html" title="IOSIconGenerator::Helpers (module)">Helpers</a></span>, <span class='object_link'><a href="IOSIconGenerator/Library.html" title="IOSIconGenerator::Library (module)">Library</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="IOSIconGenerator/Helpers.html" title="IOSIconGenerator::Helpers (module)">Helpers</a></span>
 
 
 
 
 </p>
 
+
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+
+        <dt id="VERSION-constant" class="">VERSION =
+          <div class="docstring">
+  <div class="discussion">
+
+<p>The current version of the gem.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div>
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+    </dl>
+
+
 
 
 
@@ -118,7 +158,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 19 16:25:40 2019 by
+  Generated on Thu Feb 21 14:26:30 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.18 (ruby-2.3.7).
 </div>

docs/IOSIconGenerator/CLI.html

@@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 19 16:25:40 2019 by
+  Generated on Thu Feb 21 13:11:01 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.18 (ruby-2.3.7).
 </div>

docs/IOSIconGenerator/CLI/Commands.html

@@ -112,7 +112,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Tue Feb 19 16:25:40 2019 by
+  Generated on Thu Feb 21 13:11:01 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.18 (ruby-2.3.7).
 </div>