Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
ra1028 committed Jul 31, 2018
1 parent 74479bb commit c87ee21
Show file tree
Hide file tree
Showing 22 changed files with 909 additions and 2,672 deletions.
4 changes: 2 additions & 2 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ github_url: https://github.com/ra1028/DifferenceKit
module: DifferenceKit
readme: README.md
output: docs
theme: fullwidth
theme: apple
clean: true
skip_undocumented: true
xcodebuild_arguments: [-workspace, 'DifferenceKit.xcworkspace', -scheme, 'DifferenceKit']
xcodebuild_arguments: [-workspace, 'DifferenceKit.xcworkspace', -scheme, 'DifferenceKit']
109 changes: 109 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<h1 align="center">DifferenceKit</h1>
<H4 align="center">
A fast and flexible O(n) difference algorithm framework for Swift collection.</br>
The algorithm is optimized based on the Paul Heckel's algorithm.
</H4>

<p align="center">
<a href="https://developer.apple.com/swift"><img alt="Swift4" src="https://img.shields.io/badge/language-swift4-orange.svg?style=flat"/></a>
<a href="https://developer.apple.com/swift/"><img alt="Platform" src="https://img.shields.io/badge/platform-iOS%20%7C%20tvOS-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?style=flat"/></a>
</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://cocoapods.org/pods/DifferenceKit"><img alt="CocoaPods" src="https://img.shields.io/cocoapods/v/DifferenceKit.svg"/></a>
<a href="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/Carthage/Carthage"><img alt="Carthage" src="https://img.shields.io/badge/Carthage-compatible-yellow.svg?style=flat"/></a>
</p>

---

<div style="text-align:center">
<img src="./assets/Sample.gif" width="250">
</div>

---

## Features
Coming soon.

---

## Introduction
Coming soon.

---

## Algorithm
Coming soon.

---

## Documentation
Coming soon.
Documentation is generated by [jazzy](https://github.com/realm/jazzy).

---

## Getting Started
- [Example projects](./Examples)
- Example codes:
Coming soon.

---

## Comparison with Other Frameworks
Coming soon.

---

## Requirements
- Swift4.1+
- OS X 10.9+
- tvOS 9.0+

---

## Installation

### [CocoaPods](https://cocoapods.org/)
Add the following to your `Podfile`:
```ruby
use_frameworks!

target 'TargetName' do
pod 'DifferenceKit'
end
```
To use only algorithm without extensions for UI, add the following:
```ruby
use_frameworks!

target 'TargetName' do
pod 'DifferenceKit/Core'
end
```
And run
```sh
pod install
```

### [Carthage](https://github.com/Carthage/Carthage)
Add the following to your `Cartfile`:
```ruby
github "ra1028/DifferenceKit"
```
And run
```sh
carthage update
```

---

## Contribution
Welcome to fork and submit pull requests.
Before submitting pull request, please ensure you have passed the included tests.
If your pull request including new function, please write test cases for it.

---

## License
DifferenceKit is released under the [MIT License](./LICENSE).
Binary file added assets/Sample.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
99 changes: 36 additions & 63 deletions docs/Extensions.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,110 +4,84 @@
<title>Extensions Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>

<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>

<a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>

<a title="Extensions Reference"></a>

<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
DifferenceKit Docs
</a>
(100% documented)
</p>

<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="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/ra1028/DifferenceKit">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
</p>

<header>
<div class="content-wrapper">
<p><a href="index.html">DifferenceKit Docs</a> (100% documented)</p>
<p class="header-right"><a href="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/ra1028/DifferenceKit"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">DifferenceKit Reference</a>
<img class="carat" src="img/carat.png" />
Extensions Reference
</p>

<div class="content-wrapper">
<nav class="navigation">
<p id="breadcrumbs">
<a href="index.html">DifferenceKit Reference</a>
<img id="carat" src="img/carat.png" />
Extensions Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/UICollectionView.html">UICollectionView</a>
<a href="Extensions/UICollectionView.html">UICollectionView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/UITableView.html">UITableView</a>
<a href="Extensions/UITableView.html">UITableView</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Differentiable.html">Differentiable</a>
<a href="Protocols/Differentiable.html">Differentiable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/DifferentiableSection.html">DifferentiableSection</a>
<a href="Protocols/DifferentiableSection.html">DifferentiableSection</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/AnyDifferentiable.html">AnyDifferentiable</a>
<a href="Structs/AnyDifferentiable.html">AnyDifferentiable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Changeset.html">Changeset</a>
<a href="Structs/Changeset.html">Changeset</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ElementPath.html">ElementPath</a>
<a href="Structs/ElementPath.html">ElementPath</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Section.html">Section</a>
<a href="Structs/Section.html">Section</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/StagedChangeset.html">StagedChangeset</a>
<a href="Structs/StagedChangeset.html">StagedChangeset</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">

<section class="section">
<div class="section-content">
<section>
<section class="section">
<h1>Extensions</h1>
<p>The following extensions are available globally.</p>

</div>
</section>

<section class="section">
<div class="section-content">
</section>
<section class="section task-group-section">
<div class="task-group">
<ul class="item-container">
<ul>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -164,15 +138,14 @@ <h4>Declaration</h4>
</li>
</ul>
</div>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2018-08-01)</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>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2018-08-01)</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>
</body>
</div>
</html>
Loading

0 comments on commit c87ee21

Please sign in to comment.