Skip to content

Commit d48c045

Browse files
committed
Create README.md
1 parent 0d400e5 commit d48c045

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# android-instagram
2+
3+
## Overview
4+
5+
This is the starter project for the Instagram Client Project.
6+
7+
## What's Included
8+
* <tt>com.codepath.instagram.models</tt> => We've built out the models so you can work directly with post, user, and image objects instead of having to deal with json.
9+
* <tt>com.codepath.instagram.helpers</tt> => Here you can find helpful classes / methods that will come in useful throughout the project. These will be referenced when they are needed.
10+
* <tt>Drawables</tt> => Don't worry about searching for images that will look good. We've already provided a majority of the assets you'll need.
11+
* <tt>Colors</tt> => We've included some of the colors (in <tt>colors.xml</tt>) that you'll need. You'll noticed that the mocks will refer to the color name instead of the hex value.
12+
* <tt>Dependencies</tt> => We've pulled in the dependencies you need (with the correct versions) into <tt>build.gradle</tt> so you can skip this step when you come across it in the guides. These include [Fresco](https://github.com/facebook/fresco), [RecyclerView](https://developer.android.com/reference/android/support/v7/widget/RecyclerView.html), and [android-async-http](http://loopj.com/android-async-http/).
13+
14+
## Finished Project
15+
* By the end of the project, you will have built something that looks like the following:
16+
17+
![Imgur](http://i.imgur.com/4SWlsQA.gif)

0 commit comments

Comments
 (0)