docs: animation, screenshots; feat: market, local flavors

README.md

@@ -1,17 +1,18 @@
-# RssReader
-![Animation of the app]()
+# Rss Reader for the BBC News feed
+![Animation of the app](materials/animation.gif)
 
-Rss feed reader for a BBC network news feed. Works fast, utilises MVP architecture and several modern libraries to perform REST work, image downloading and caching.
+Rss feed reader for the BBC network news feed. Works fast, utilises MVP architecture and several modern libraries to perform REST work, image downloading and caching.
+* Screenshots of a current state - [phone and tablet Screenshots](materials/).
 
-# Requirements
+## Requirements
 * [Specifications](materials/Android Developer Interview Assignment.pdf).
 * To be simple enough to make it under 8 hours - this caused me to make several sacrifices:
   * Realm instead of SQLite, therefore inability to use a ContentProvider.
   * Without a ContentProvider - no SyncAdapter, which would be the best way to perform battery-efficient regular updates.
 * API to get data in XML format: [BBC](http://feeds.bbci.co.uk/news/rss.xml)
 * Tablet Design.
 
-# Features
+## Features
 * Used MVP Architecture for the app.
 * Realm Database for caching and storing the data.
 * Accessibility features: RTL, content descriptions, empty TextView when there are no articles.
@@ -22,17 +23,19 @@ Rss feed reader for a BBC network news feed. Works fast, utilises MVP architectu
 * Scroll to the top by clicking the ActionBar.
 * Palette to have a nice-looking design.
 * For API 21+ - auto-updates in background with notifications (JobScheduler).
+* Market (without BBC logos) and Local (BBC branded) flavors.
 
-# Libraries
+## Libraries
 * [Realm](https://realm.io) - fast and efficient database, which dramatically increases a speed of development.
 * [Butterknife](http://jakewharton.github.io/butterknife/) - boilerplate code cutter, improves speed of development, makes code easier to read.
 * [Retrofit](http://square.github.io/retrofit/) - basically the standard in the Android development for all REST-related works.
 * [RxJava](https://github.com/ReactiveX/RxAndroid), [Retrolambda](https://github.com/evant/gradle-retrolambda) - most modern way to manage streams of data and asynctasks and a plugin to make us of nice Java 8 lambda syntax.
 * [Picasso](http://square.github.io/picasso/) - one of the best image downloading and caching libraries for Android, increases speed of development.
 
-# Used materials
+## Used materials
 * BBC Icon - [www.iconarchive.com](http://www.iconarchive.com/show/circle-icons-by-martz90/bbc-news-icon.html).
 * BBC Logo - [wikimedia.org](https://upload.wikimedia.org/wikipedia/commons/e/eb/BBC.svg).
+* RSS Font Awesome - [wikimedia.org](https://upload.wikimedia.org/wikipedia/commons/d/dc/Rss_font_awesome.svg).
 
 License
 -------

app/build.gradle

@@ -32,7 +32,6 @@ android {
     buildToolsVersion "24.0.0"
 
     defaultConfig {
-        applicationId "com.adkdevelopment.rssreader"
         minSdkVersion 16
         targetSdkVersion 24
         versionCode 1
@@ -44,6 +43,14 @@ android {
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
+    productFlavors{
+        local {
+            applicationId "com.adkdevelopment.bbcreader"
+        }
+        market {
+            applicationId "com.adkdevelopment.rssreader"
+        }
+    }
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8

app/src/main/res/values/strings.xml

@@ -23,7 +23,7 @@
   -->
 
 <resources>
-    <string name="app_name">Rss Reader</string>
+    <string name="app_name">BBC Reader</string>
     <string name="share">Share</string>
     <string name="menu_button_settings">Settings</string>
     <string name="recyclerview_empty_text">Oops! Something is wrong. Please check your internet connection and try again.</string>

app/src/market/res/drawable/logo_rss.xml

@@ -0,0 +1,28 @@
+<!--
+  ~ MIT License
+  ~
+  ~ Copyright (c) 2016. Dmytro Karataiev
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in all
+  ~ copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  ~ SOFTWARE.
+  -->
+
+<vector android:height="24dp" android:viewportHeight="1792.0"
+    android:viewportWidth="1792.0" android:width="24dp" xmlns:android="http://schemas.android.com/apk/res/android">
+    <path android:fillColor="#FFFFFF" android:pathData="M596.6,1410.2Q596.6,1490.2 540.6,1546.2 484.6,1602.2 404.6,1602.2 324.6,1602.2 268.6,1546.2 212.6,1490.2 212.6,1410.2q0,-80 56,-136 56,-56 136,-56 80,0 136,56 56,56 56,136zM1108.6,1533.2Q1110.6,1561.2 1091.6,1581.2 1073.6,1602.2 1044.6,1602.2L909.6,1602.2Q884.6,1602.2 866.6,1585.7 848.6,1569.2 846.6,1544.2 824.6,1315.2 662.1,1152.7 499.6,990.2 270.6,968.2 245.6,966.2 229.1,948.2 212.6,930.2 212.6,905.2l0,-135q0,-29 21,-47 17,-17 43,-17l5,0Q441.6,719.2 587.6,786.7 733.6,854.2 846.6,968.2 960.6,1081.2 1028.1,1227.2 1095.6,1373.2 1108.6,1533.2zM1620.6,1535.2Q1622.6,1562.2 1602.6,1582.2 1584.6,1602.2 1556.6,1602.2L1413.6,1602.2Q1387.6,1602.2 1369.1,1584.7 1350.6,1567.2 1349.6,1542.2 1337.6,1327.2 1248.6,1133.7 1159.6,940.2 1017.1,797.7 874.6,655.2 681.1,566.2 487.6,477.2 272.6,464.2 247.6,463.2 230.1,444.7 212.6,426.2 212.6,401.2l0,-143q0,-28 20,-46 18,-18 44,-18l3,0Q541.6,207.2 781.1,314.2 1020.6,421.2 1206.6,608.2 1393.6,794.2 1500.6,1033.7 1607.6,1273.2 1620.6,1535.2z"/>
+</vector>

app/src/market/res/drawable/logo_title.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ MIT License
+  ~
+  ~ Copyright (c) 2016. Dmytro Karataiev
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in all
+  ~ copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  ~ SOFTWARE.
+  -->
+
+<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
+    <item
+        android:drawable="@drawable/logo_rss"
+        android:right="10dp" />
+</layer-list>

app/src/market/res/values/strings.xml

@@ -0,0 +1,27 @@
+<!--
+  ~ MIT License
+  ~
+  ~ Copyright (c) 2016. Dmytro Karataiev
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy
+  ~ of this software and associated documentation files (the "Software"), to deal
+  ~ in the Software without restriction, including without limitation the rights
+  ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  ~ copies of the Software, and to permit persons to whom the Software is
+  ~ furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in all
+  ~ copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  ~ SOFTWARE.
+  -->
+
+<resources>
+    <string name="app_name">RSS Reader</string>
+</resources>

materials/README.md

@@ -0,0 +1,11 @@
+# Screenshots of the App
+
+## Phone Screenshots
+![Mobile phone screenshots](phone_screenshot.jpg)
+
+## Tablet Screenshots
+![Tablet Screenshot 1](tablet_screenshot_1.jpg)
+
+![Tablet Screenshot 2](tablet_screenshot_2.jpg)
+
+![Tablet Screenshot 3](tablet_screenshot_3.jpg)