Skip to content

Commit

Permalink
Updated ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
@joshc89
joshc89 committed Apr 27, 2016
1 parent aa1ad44 commit cd2ace9
Show file tree
Hide file tree
Showing 65 changed files with 285 additions and 135 deletions.
8 changes: 5 additions & 3 deletions ReadMe.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ Develop faster with convenience functions from The Distance.

## Features

Reducing boilerplate code helps us to develop features faster and ensure they remain bug free, with platform updates and so we don't forget tricky edge cases.
Reducing boilerplate code helps us to develop features faster and ensure they remain bug free with platform updates and so we don't forget tricky edge cases.

**TheDistanceCore** contains simple extensions and reusable classes that are references in multiple projects. The purpose of this project is to contain small pieces of functionality that are very general. More specific code, or code that has dependencies on other frameworks, should not be included here.
**TheDistanceCore** contains simple extensions and reusable classes that are referenced in multiple projects. The purpose of this project is to contain small pieces of functionality that are very general. More specific code, or code that has dependencies on other frameworks, should not be included here.

[Full Documentation](http://thedistance.github.io/TheDistanceCore/) is available on our GitHub Pages site.

Functionality includes:

Expand All @@ -42,7 +44,7 @@ Other features include:
- If you have **found a bug**, open an issue.
- If you have **a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
- If you'd like to **ask a general question**, email <dev[email protected]>.
- If you'd like to **ask a general question**, email us on <hello[email protected]>.

## Installation

Expand Down
5 changes: 3 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<header>
<div class="content-wrapper">
<p><a href="index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -266,8 +267,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Classes/NotificationObserver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -427,8 +428,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Classes/ObjectObserver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -494,8 +495,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Classes/ObjectTarget.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -331,8 +332,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<header>
<div class="content-wrapper">
<p><a href="index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -205,8 +206,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Enums/UIPopoverSourceType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -242,8 +243,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Extensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<header>
<div class="content-wrapper">
<p><a href="index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -554,8 +555,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Extensions/CGRect.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -258,8 +259,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Extensions/CLError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -225,8 +226,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Extensions/Dictionary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -288,8 +289,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Extensions/NSDate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -198,8 +199,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Extensions/NSDateComponents.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -231,8 +232,8 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/Extensions/NSError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<header>
<div class="content-wrapper">
<p><a href="../index.html">TheDistanceCore Docs</a> (99% documented)</p>
<p class="header-right"><a href="https://github.com/thedistance/TheDistanceCore"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -229,8 +230,8 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="https://bitbucket.org/thedistance/thedistancecore" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2016 <a class="link" href="https://github.com/thedistance" target="_blank" rel="external">Josh Campion @ The Distance</a>. All rights reserved. (Last updated: 2016-04-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit cd2ace9

Please sign in to comment.