Readme and docs

- Add gifs for the readme - Add /docs to project root for github pages
Hadryan · Mar 24, 2017 · ed11bd8 · ed11bd8
1 parent 0c011be
commit ed11bd8
Show file tree

Hide file tree

Showing 53 changed files with 9,754 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![Spruce Logo](https://github.com/willowtreeapps/spruce-android/blob/develop/imgs/header_image.png)
+![Spruce Logo](https://github.com/willowtreeapps/spruce-android/blob/master/imgs/header_image.png)
 
 # Spruce Android Animation Library
 [![CircleCI Build Status](https://circleci.com/gh/willowtreeapps/spruce-android.svg?style=shield)](https://circleci.com/gh/willowtreeapps/spruce-android)
@@ -8,6 +8,8 @@
 ## What is it?
 Spruce is a lightweight animation library that helps choreograph the animations on the screen. With so many different animation libraries out there, developers need to make sure that each view is animating at the appropriate time. Spruce can help designers request complex multi-view animations and not have the developers cringe at the prototype.
 
+![left](https://github.com/willowtreeapps/spruce-android/blob/master/imgs/top-left-corner.gif)![recycler](https://github.com/willowtreeapps/spruce-android/blob/master/imgs/recycler-example.gif)![right](https://github.com/willowtreeapps/spruce-android/blob/master/imgs/bottom-right-corner.gif)
+
 ### Gradle
 Add the following to your project's build.gradle file
 
@@ -18,7 +20,7 @@ dependencies {
 ```
 
 ## Documentation
-For javadocs checkout [the documentation](https://willowtreeapps.github.io/spruce-android/javadoc_output/index.html) for more information.
+For javadocs checkout [the documentation](https://willowtreeapps.github.io/spruce-android/docs/index.html) for more information.
 
 ## Basic Usage
 ```java
@@ -29,7 +31,7 @@ Animator spruceAnimator = new Spruce
         .start();
 ```
 
-Checkout [the builder documentation](https://willowtreeapps.github.io/spruce-android/javadoc_output/com/willowtreeapps/spruce/Spruce.SpruceBuilder.html) for more information.
+Checkout [the builder documentation](https://willowtreeapps.github.io/spruce-android/docs/com/willowtreeapps/spruce/Spruce.SpruceBuilder.html) for more information.
 
 ### Preparing for Animation
 Spruce comes packed with `Animator` options within the `DefaultAnimations` class meant to make your life easier when calling an animation. Let's say we want to have your views fade in. For example, we would create an `animators = new Animator[] {}` and add `DefaultAnimations.fadeInAnimator(parentViewGroup, /*duration=*/800)` as an array item.
@@ -47,7 +49,7 @@ Animator spruceAnimator = new Spruce
         .start();
 ```
 
-Checkout [the builder documentation](https://willowtreeapps.github.io/spruce-android/javadoc_output/com/willowtreeapps/spruce/animation/DefaultAnimations.html) for more information.
+Checkout [the builder documentation](https://willowtreeapps.github.io/spruce-android/docs/com/willowtreeapps/spruce/animation/DefaultAnimations.html) for more information.
 
 ## Using a SortFunction
 Luckily, Spruce comes with 8 `SortFunction` implementations with a wide open possibility to make more! Use the `SortFunction` to change the order in which views animate. Consider the following example:
@@ -98,7 +100,7 @@ To make sure that developers can use Spruce out of the box, we included about 8
 - `ContinousSort`
 - `ContinuousWeightedSort`
 
-Check out the docs [here](https://willowtreeapps.github.io/spruce-android/javadoc_output/com/willowtreeapps/spruce/sort/SortFunction.html) for more information
+Check out the docs [here](https://willowtreeapps.github.io/spruce-android/docs/com/willowtreeapps/spruce/sort/SortFunction.html) for more information
 
 ## Stock Animators
 To make everybody's lives easier, the stock animators perform basic `View` animations that a lot of apps use today. Mix and match these animators to get the core motion you are looking for.

diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_65) on Fri Mar 17 15:59:04 EDT 2017 -->
+<title>All Classes</title>
+<meta name="date" content="2017-03-17">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<h1 class="bar">All&nbsp;Classes</h1>
+<div class="indexContainer">
+<ul>
+<li><a href="com/willowtreeapps/spruce/sort/ContinuousSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">ContinuousSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/ContinuousWeightedSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">ContinuousWeightedSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/CorneredSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">CorneredSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/CorneredSort.Corner.html" title="enum in com.willowtreeapps.spruce.sort" target="classFrame">CorneredSort.Corner</a></li>
+<li><a href="com/willowtreeapps/spruce/animation/DefaultAnimations.html" title="class in com.willowtreeapps.spruce.animation" target="classFrame">DefaultAnimations</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/DefaultSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">DefaultSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/InlineSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">InlineSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/LinearSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">LinearSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/LinearSort.Direction.html" title="enum in com.willowtreeapps.spruce.sort" target="classFrame">LinearSort.Direction</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/RadialSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">RadialSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/RadialSort.Position.html" title="enum in com.willowtreeapps.spruce.sort" target="classFrame">RadialSort.Position</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/RandomSort.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">RandomSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/SortFunction.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">SortFunction</a></li>
+<li><a href="com/willowtreeapps/spruce/Spruce.html" title="class in com.willowtreeapps.spruce" target="classFrame">Spruce</a></li>
+<li><a href="com/willowtreeapps/spruce/Spruce.SpruceBuilder.html" title="class in com.willowtreeapps.spruce" target="classFrame">Spruce.SpruceBuilder</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/SpruceTimedView.html" title="class in com.willowtreeapps.spruce.sort" target="classFrame">SpruceTimedView</a></li>
+</ul>
+</div>
+</body>
+</html>
diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (1.8.0_65) on Fri Mar 17 15:59:04 EDT 2017 -->
+<title>All Classes</title>
+<meta name="date" content="2017-03-17">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+</head>
+<body>
+<h1 class="bar">All&nbsp;Classes</h1>
+<div class="indexContainer">
+<ul>
+<li><a href="com/willowtreeapps/spruce/sort/ContinuousSort.html" title="class in com.willowtreeapps.spruce.sort">ContinuousSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/ContinuousWeightedSort.html" title="class in com.willowtreeapps.spruce.sort">ContinuousWeightedSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/CorneredSort.html" title="class in com.willowtreeapps.spruce.sort">CorneredSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/CorneredSort.Corner.html" title="enum in com.willowtreeapps.spruce.sort">CorneredSort.Corner</a></li>
+<li><a href="com/willowtreeapps/spruce/animation/DefaultAnimations.html" title="class in com.willowtreeapps.spruce.animation">DefaultAnimations</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/DefaultSort.html" title="class in com.willowtreeapps.spruce.sort">DefaultSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/InlineSort.html" title="class in com.willowtreeapps.spruce.sort">InlineSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/LinearSort.html" title="class in com.willowtreeapps.spruce.sort">LinearSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/LinearSort.Direction.html" title="enum in com.willowtreeapps.spruce.sort">LinearSort.Direction</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/RadialSort.html" title="class in com.willowtreeapps.spruce.sort">RadialSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/RadialSort.Position.html" title="enum in com.willowtreeapps.spruce.sort">RadialSort.Position</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/RandomSort.html" title="class in com.willowtreeapps.spruce.sort">RandomSort</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/SortFunction.html" title="class in com.willowtreeapps.spruce.sort">SortFunction</a></li>
+<li><a href="com/willowtreeapps/spruce/Spruce.html" title="class in com.willowtreeapps.spruce">Spruce</a></li>
+<li><a href="com/willowtreeapps/spruce/Spruce.SpruceBuilder.html" title="class in com.willowtreeapps.spruce">Spruce.SpruceBuilder</a></li>
+<li><a href="com/willowtreeapps/spruce/sort/SpruceTimedView.html" title="class in com.willowtreeapps.spruce.sort">SpruceTimedView</a></li>
+</ul>
+</div>
+</body>
+</html>