From c8b3a056d212fb1f2a3be9c5b571320255e8c367 Mon Sep 17 00:00:00 2001
From: hmalik144 <h.malik144@gmail.com>
Date: Wed, 30 Sep 2020 14:49:27 +0100
Subject: [PATCH] Create README.md

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..433dec1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+# DaysLeft
+
+A shift tracker for rural work carried out by backpackers.
+
+# Overview
+
+Working holider makers in australia are given the option to carry out 3 months of rural work in exchange for a second year working holiday visa. The problem with working holiday makers carrying out rural work many are subjected to exploitation and abude. 
+Here is an article in The Guardian outlining the horrible conditions
+
+This is part of the problem within rural work, but one of many issues is exploitation on pay. I created this application to tackle the problem.
+With days left a backpacker can track the work they have done and dispute exploitation when its "their word against mine".
+
+# Features
+
+## Simple sign up
+All you need is an email address and password (Social media sign up coming soon)
+
+## Find employer
+Easily find the employer you are working for by their ABN (Australian business number) or name. This ensures you are working for a legal entity.
+
+## Simple shift logging
+Once you have submitted a shift it is simple to repeat. If you are working for an agency it is simple to log various employers.
+
+## Visa data compilation
+Compiling data for your second year visa application is long and tedious - with days left at the click of a button you can have your data needed for download.
+
+## Piece rate accepted
+Many other working day trackers only work for hourly paid shifts. Days left incorporates the tracking of piece rate (eg. $6.00 per kg or $2.00 per bucket) shifts which you can log and track.
+
+## Home screen metric
+Includes the progress so far through your 88 days. Piece rate totals, hourly paid totals and accumulated totals.
+
+# Sample Screenshots
+
+
+
+# Issues
+
+## Download compilations 
+Currently the android security settings prevent downloading files from the web without predefined security parameters.
+
+## Sortation and filter
+A few teething issues with filtering and sorting list
+
+## Architectural Pattern
+
+MVVM - Model View ViewModel
+SOLID coding
+Firebase with a more modular design
+
+## Jetpack
+
+* [AndroidX](https://developer.android.com/jetpack)
+
+## Built With
+
+* [Kodein](https://github.com/Kodein-Framework/Kodein-DI) - Painless Kotlin Dependency Injection
+* [Firebase](https://firebase.google.com/) - Firebase is a mobile and web application development platform developed by Firebase
+* [Gson](https://github.com/google/gson)- A Java serialization/deserialization library to convert Java Objects into JSON and back
+* [Picasso](https://square.github.io/picasso/) - A powerful image downloading and caching library for Android
+
+## Submitted by
+
+* **Haider Malik** - *Android Developer*