Skip to content

Commit

Permalink
[2.0.0] release. bump version. gen docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jessesquires committed Jan 27, 2024
1 parent 519b2bd commit 345f99b
Show file tree
Hide file tree
Showing 13 changed files with 260 additions and 227 deletions.
2 changes: 1 addition & 1 deletion AboutThisApp.podspec
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'AboutThisApp'
s.version = '1.1.0'
s.version = '2.0.0'
s.license = 'MIT'

s.summary = 'A standard, customizable "About This App" panel for any Mac app'
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ panel.makeKeyAndOrderFront(nil)
### [CocoaPods](http://cocoapods.org)

````ruby
pod 'AboutThisApp', '~> 1.0.0'
pod 'AboutThisApp', '~> 2.0.0'
````

### [Swift Package Manager](https://swift.org/package-manager/)
Expand All @@ -47,7 +47,7 @@ Add `AboutThisApp` to the `dependencies` value of your `Package.swift`.

```swift
dependencies: [
.package(url: "https://github.com/hexedbits/AboutThisApp", from: "1.0.0")
.package(url: "https://github.com/hexedbits/AboutThisApp", from: "2.0.0")
]
```

Expand Down
13 changes: 8 additions & 5 deletions docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">AboutThisApp 1.1.0 Docs</a> (100% documented)</p>
<p><a href="index.html">AboutThisApp 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/hexedbits/AboutThisApp"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -61,6 +61,9 @@
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/AboutThisAppView.html">AboutThisAppView</a>
</li>
<li class="nav-group-task">
<a href="Structs/AppMetadata.html">AppMetadata</a>
</li>
Expand Down Expand Up @@ -109,9 +112,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/c:@M@AboutThisApp@objc(cs)AboutThisAppViewController"></a>
<a name="/s:12AboutThisApp0abC14ViewControllerC"></a>
<a name="//apple_ref/swift/Class/AboutThisAppViewController" class="dashAnchor"></a>
<a class="token" href="#/c:@M@AboutThisApp@objc(cs)AboutThisAppViewController">AboutThisAppViewController</a>
<a class="token" href="#/s:12AboutThisApp0abC14ViewControllerC">AboutThisAppViewController</a>
</code>
</div>
<div class="height-container">
Expand All @@ -127,7 +130,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">AboutThisAppViewController</span> <span class="p">:</span> <span class="kt">NSViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">AboutThisAppViewController</span> <span class="p">:</span> <span class="kt">NSHostingController</span><span class="o">&lt;</span><span class="kt"><a href="Structs/AboutThisAppView.html">AboutThisAppView</a></span><span class="o">&gt;</span></code></pre>

</div>
</div>
Expand All @@ -139,7 +142,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-01-09)</p>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-01-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
7 changes: 5 additions & 2 deletions docs/Classes/AboutThisAppPanel.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="AboutThisAppPanel Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">AboutThisApp 1.1.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">AboutThisApp 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/hexedbits/AboutThisApp"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -61,6 +61,9 @@
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/AboutThisAppView.html">AboutThisAppView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/AppMetadata.html">AppMetadata</a>
</li>
Expand Down Expand Up @@ -163,7 +166,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-01-09)</p>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-01-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
208 changes: 7 additions & 201 deletions docs/Classes/AboutThisAppViewController.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="AboutThisAppViewController Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">AboutThisApp 1.1.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">AboutThisApp 2.0.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/hexedbits/AboutThisApp"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -61,6 +61,9 @@
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/AboutThisAppView.html">AboutThisAppView</a>
</li>
<li class="nav-group-task">
<a href="../Structs/AppMetadata.html">AppMetadata</a>
</li>
Expand All @@ -75,7 +78,7 @@ <h1>AboutThisAppViewController</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">AboutThisAppViewController</span> <span class="p">:</span> <span class="kt">NSViewController</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">AboutThisAppViewController</span> <span class="p">:</span> <span class="kt">NSHostingController</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/AboutThisAppView.html">AboutThisAppView</a></span><span class="o">&gt;</span></code></pre>

</div>
</div>
Expand All @@ -84,15 +87,6 @@ <h1>AboutThisAppViewController</h1>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Properties"></a>
<h3 class="section-name"><span>Properties</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
Expand All @@ -107,7 +101,7 @@ <h3 class="section-name"><span>Properties</span>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The app&rsquo;s metadata.</p>
<p>The app metadata.</p>

</div>
<div class="declaration">
Expand All @@ -121,194 +115,6 @@ <h4>Declaration</h4>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Views"></a>
<a name="//apple_ref/swift/Section/Views" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Views"></a>
<h3 class="section-name"><span>Views</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:12AboutThisApp0abC14ViewControllerC09iconImageD0So07NSImageD0Cvp"></a>
<a name="//apple_ref/swift/Property/iconImageView" class="dashAnchor"></a>
<a class="token" href="#/s:12AboutThisApp0abC14ViewControllerC09iconImageD0So07NSImageD0Cvp">iconImageView</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The image view containing the app icon.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
This displays <code>self.metadata.icon</code>.

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">iconImageView</span><span class="p">:</span> <span class="kt">NSImageView</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12AboutThisApp0abC14ViewControllerC12appNameLabelSo11NSTextFieldCvp"></a>
<a name="//apple_ref/swift/Property/appNameLabel" class="dashAnchor"></a>
<a class="token" href="#/s:12AboutThisApp0abC14ViewControllerC12appNameLabelSo11NSTextFieldCvp">appNameLabel</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The label containing the app name.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
This displays <code>self.metadata.name</code>.

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">appNameLabel</span><span class="p">:</span> <span class="kt">NSTextField</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12AboutThisApp0abC14ViewControllerC13versionButtonSo8NSButtonCvp"></a>
<a name="//apple_ref/swift/Property/versionButton" class="dashAnchor"></a>
<a class="token" href="#/s:12AboutThisApp0abC14ViewControllerC13versionButtonSo8NSButtonCvp">versionButton</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The button displaying the app version number.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
This displays <code>self.metadata.versionText</code>.
When clicked, it toggles to display <code>self.metadata.altVersionText</code>.
This can be used to display additional information or &lsquo;easter egg&rsquo; text.

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">versionButton</span><span class="p">:</span> <span class="kt">NSButton</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12AboutThisApp0abC14ViewControllerC9urlButtonSo8NSButtonCSgvp"></a>
<a name="//apple_ref/swift/Property/urlButton" class="dashAnchor"></a>
<a class="token" href="#/s:12AboutThisApp0abC14ViewControllerC9urlButtonSo8NSButtonCSgvp">urlButton</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The button displaying the app url.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
This displays <code>self.metadata.url</code>.

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">urlButton</span><span class="p">:</span> <span class="kt">NSButton</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12AboutThisApp0abC14ViewControllerC14copyrightLabelSo11NSTextFieldCvp"></a>
<a name="//apple_ref/swift/Property/copyrightLabel" class="dashAnchor"></a>
<a class="token" href="#/s:12AboutThisApp0abC14ViewControllerC14copyrightLabelSo11NSTextFieldCvp">copyrightLabel</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The label displaying the app copyright text.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
This displays <code>self.metadata.copyrightText</code>.

</div>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">copyrightLabel</span><span class="p">:</span> <span class="kt">NSTextField</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Init"></a>
<a name="//apple_ref/swift/Section/Init" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Init"></a>
<h3 class="section-name"><span>Init</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -360,7 +166,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-01-09)</p>
<p>&copy; 2024 <a class="link" href="https://jessesquires.com" target="_blank" rel="external noopener">Jesse Squires</a>. All rights reserved. (Last updated: 2024-01-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 345f99b

Please sign in to comment.