Update docs

riadiAanru · Feb 17, 2019 · 2eee2c6 · 2eee2c6
1 parent 0ee5efe
commit 2eee2c6
Show file tree

Hide file tree

Showing 16 changed files with 56 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -358,7 +358,7 @@ DifferenceKit was developed with reference to the following excellent materials.
 
 - [A technique for isolating differences between files](https://dl.acm.org/citation.cfm?id=359467) by [Paul Heckel](https://dl.acm.org/author_page.cfm?id=81100051772)
 - [DifferenceAlgorithmComparison](https://github.com/horita-yuya/DifferenceAlgorithmComparison) by [@horita-yuya](https://github.com/horita-yuya)
-- [RxDataSources](https://github.com/RxSwiftCommunity/RxDataSources) by [@kzaher](https://github.com/kzaher), [RxSwiftCommunity](https://github.com/RxSwiftCommunity)
+- [RxDataSources](https://github.com/RxSwiftCommunity/RxDataSources) by [@kzaher](https://github.com/kzaher), [RxSwiftCommunity](https://github.com/RxSwiftCommunity)
 
 #### OSS using DifferenceKit
 The list of the awesome OSS which uses this library. 

diff --git a/docs/Extensions.html b/docs/Extensions.html
@@ -179,7 +179,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Optional.html b/docs/Extensions/Optional.html
@@ -153,7 +153,7 @@ <h4>Return Value</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/UICollectionView.html b/docs/Extensions/UICollectionView.html
@@ -181,7 +181,7 @@ <h4>Parameters</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/UITableView.html b/docs/Extensions/UITableView.html
@@ -355,7 +355,7 @@ <h4>Parameters</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Protocols.html b/docs/Protocols.html
@@ -185,7 +185,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Protocols/ContentEquatable.html b/docs/Protocols/ContentEquatable.html
@@ -160,7 +160,7 @@ <h4>Return Value</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Protocols/Differentiable.html b/docs/Protocols/Differentiable.html
@@ -161,7 +161,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Protocols/DifferentiableSection.html b/docs/Protocols/DifferentiableSection.html
@@ -211,7 +211,7 @@ <h4>Parameters</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Structs.html b/docs/Structs.html
@@ -315,7 +315,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Structs/AnyDifferentiable.html b/docs/Structs/AnyDifferentiable.html
@@ -307,7 +307,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Structs/ArraySection.html b/docs/Structs/ArraySection.html
@@ -420,7 +420,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Structs/Changeset.html b/docs/Structs/Changeset.html
@@ -732,7 +732,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Structs/ElementPath.html b/docs/Structs/ElementPath.html
@@ -247,7 +247,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/Structs/StagedChangeset.html b/docs/Structs/StagedChangeset.html
@@ -709,7 +709,7 @@ <h4>Declaration</h4>
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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/index.html b/docs/index.html
@@ -99,7 +99,7 @@ <H4 align="center">
 </br>
 <a href="https://travis-ci.org/ra1028/DifferenceKit"><img alt="Build Status" src="https://travis-ci.org/ra1028/DifferenceKit.svg?branch=master"/></a>
 <a href="https://developer.apple.com/"><img alt="Platform" src="https://img.shields.io/badge/platform-iOS%20%7C%20OSX%20%7C%20tvOS%20%7C%20watchOS-green.svg"/></a>
-<a href="https://github.com/ra1028/DifferenceKit/blob/master/LICENSE"><img alt="Lincense" src="https://img.shields.io/badge/license-MIT-000000.svg"/></a>
+<a href="https://github.com/ra1028/DifferenceKit/blob/master/LICENSE"><img alt="Lincense" src="https://img.shields.io/badge/License-Apache%202.0-black.svg"/></a>
 </p>
 
 <hr>
@@ -682,15 +682,53 @@ <h2 id='contribution' class='heading'>Contribution</h2>
 Before submitting pull request, please ensure you have passed the included tests.<br>
 If your pull request including new function, please write test cases for it. </p>
 
+<hr>
+<h2 id='credit' class='heading'>Credit</h2>
+<h4 id='bibliography' class='heading'>Bibliography</h4>
+
+<p>DifferenceKit was developed with reference to the following excellent materials. </p>
+
+<ul>
+<li><a href="https://dl.acm.org/citation.cfm?id=359467">A technique for isolating differences between files</a> by <a href="https://dl.acm.org/author_page.cfm?id=81100051772">Paul Heckel</a></li>
+<li><a href="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/horita-yuya/DifferenceAlgorithmComparison">DifferenceAlgorithmComparison</a> by <a href="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/horita-yuya">@horita-yuya</a></li>
+<li><a href="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/RxSwiftCommunity/RxDataSources">RxDataSources</a> by <a href="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/kzaher">@kzaher</a>, <a href="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/RxSwiftCommunity">RxSwiftCommunity</a></li>
+</ul>
+<h4 id='oss-using-differencekit' class='heading'>OSS using DifferenceKit</h4>
+
+<p>The list of the awesome OSS which uses this library.<br>
+They also help to understanding how to use DifferenceKit. </p>
+
+<ul>
+<li><a href="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/RocketChat/Rocket.Chat.iOS">Rocket.Chat.iOS</a> by <a href="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/RocketChat">RocketChat</a></li>
+<li><a href="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/wireapp/wire-ios">wire-ios</a> by <a href="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/wireapp">wireapp</a></li>
+<li><a href="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/plangrid/ReactiveLists">ReactiveLists</a> by <a href="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/plangrid">plangrid</a></li>
+<li><a href="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/cardoso/ReduxMovieDB">ReduxMovieDB</a> by <a href="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/cardoso">cardoso</a></li>
+<li><a href="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/skagedal/TetrisDiffingCompetition">TetrisDiffingCompetition</a> by <a href="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/skagedal">skagedal</a></li>
+</ul>
+<h4 id='other-diffing-libraries' class='heading'>Other diffing libraries</h4>
+
+<p>I respect and ️❤️ all libraries involved in diffing. </p>
+
+<ul>
+<li><a href="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/Instagram/IGListKit">IGListKit</a> by <a href="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/Instagram">Instagram</a></li>
+<li><a href="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/RACCommunity/FlexibleDiff">FlexibleDiff</a> by <a href="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/andersio">andersio</a>, <a href="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/RACCommunity">RACCommunity</a></li>
+<li><a href="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/onmyway133/DeepDiff">DeepDiff</a> by <a href="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/onmyway133">onmyway133</a></li>
+<li><a href="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/osteslag/Changeset">Changeset</a> by <a href="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/osteslag">osteslag</a></li>
+<li><a href="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/tonyarnold/Differ">Differ</a> by <a href="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/tonyarnold">tonyarnold</a></li>
+<li><a href="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/wokalski/Diff.swift">Diff.swift</a> by <a href="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/wokalski">wokalski</a></li>
+<li><a href="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/jflinter/Dwifft">Dwifft</a> by <a href="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/jflinter">jflinter</a></li>
+<li><a href="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/lxcid/ListDiff">ListDiff</a> by <a href="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/lxcid">lxcid</a></li>
+</ul>
+
 <hr>
 <h2 id='license' class='heading'>License</h2>
 
-<p>DifferenceKit is released under the <a href="https://github.com/ra1028/DifferenceKit/blob/master/LICENSE">MIT License</a>.</p>
+<p>DifferenceKit is released under the <a href="https://github.com/ra1028/DifferenceKit/blob/master/LICENSE">Apache 2.0 License</a>.</p>
 
  </section>
  </section>
  <section id="footer">
- <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-08)</p>
+ <p>&copy; 2019 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2019-02-18)</p>
  <p>Generated by <a class="link" href="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/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>