aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBryson Steck <steck.bryson@gmail.com>2021-05-10 12:54:31 -0600
committerBryson Steck <steck.bryson@gmail.com>2021-05-10 12:54:31 -0600
commit793241fe47c09c63e2a2e5a4429deed8e7401754 (patch)
tree66c4660417b4cc472c34828f0de26a98403968ff /README.md
parent2734f6777a6b7c439d9bc55c8756155721f76fa5 (diff)
downloadwiimmfi-watcher-793241fe47c09c63e2a2e5a4429deed8e7401754.tar
wiimmfi-watcher-793241fe47c09c63e2a2e5a4429deed8e7401754.tar.gz
wiimmfi-watcher-793241fe47c09c63e2a2e5a4429deed8e7401754.tar.bz2
added todo list file, app icon and implemented about fragment
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 18 insertions, 6 deletions
diff --git a/README.md b/README.md
index d50d626..08f73e2 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,24 @@
## This is the `dev` branch!!
-**You are on the `dev` branch for Wiimmfi Watcher.** This is seperate from the `master` branch, which contains the currently most stable version, while this branch is made for me to work on the app without changing currently stable code. If you are looking for the `master` branch, [click here.](https://github.com/brysonsteck/wiimmfi-watcher/tree/master)
+**You are on the `dev` branch for Wiimmfi Watcher.** This is seperate from the `master` branch, which contains the currently most stable version (which is the version currently avaliable on the Google Play Store), while this branch is made for me to work on the app without changing currently stable code. If you are looking for the `master` branch, [click here.](https://github.com/brysonsteck/wiimmfi-watcher/tree/master)
# Wiimmfi Watcher
-Wiimmfi Watcher is an Android application that allows you to watch Mario Kart Wii gameplay by simply entering your friend code.
+Wiimmfi Watcher is an Android application that allows you to watch Mario Kart Wii gameplay by simply entering your friend code. This application can be found on the Google Play Store here (link goes here when created)!
-## TODO
+This application is currently being maintained by myself out of love for Mario Kart Wii and appreciation for the developers of Wiimmfi. I am in no way affiliated with Wiimmfi or any of the Wiimmfi developers.
-* Fix the repeating recent friend codes (if possible)
-* Create the app on the Play Store
-* Create a meaningful README
+## Screenshots
+
+(Screenshots go here)
+
+## Download
+
+You can visit the Google Play Store to download the most recent and stable version (link). You are also free to clone the repository and download the source code for the most stable release in the Releases tab.
+
+## Feedback
+
+This is officially my first project and Google Play app that I'm maintaining, so if you have any feedback about my work, I would love to hear it! You can create an issue tagged "feedback", or you can fill out this Google Form. (Create google form) I also have a section in my TODO list under "Features I would like to add" for things I am already considering adding to future releases.
+
+## Bugs
+
+If you found any bugs in the `master` branch (i. e. the most recent Google Play release), **PLEASE READ MY TODO LIST FIRST** to make sure that the bug you found isn't something I'm already aware of. Once you have made sure of that, you can then create an issue or fill out this Google Form. (Link the new Google form)