From 966c999e452ac06cdf3f1206a20bc06e174469a2 Mon Sep 17 00:00:00 2001
From: Heini Halmetoja <heini.halmetoja@utu.fi>
Date: Fri, 17 Apr 2020 19:42:42 +0300
Subject: [PATCH] Update README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7771f84..81ff1bb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
 # RssReaderApp
-Just a project to learn Kotlin
-It's a mess.
+
+RssReaderApp on Kotlin- ohjelmointikielellä kirjoitettu mobiilisovellus Androida- alustalle. Sovelluksen minimivaatimuksena on Android Ice Cream Sandwich 4.0.3-4.0.4.
+
+## Sovelluksen toiminta
+Sovellus lukee RSS uutissyötteen seuraavilta sivustoilta:
+
+- [Yle uutiset](https://feeds.yle.fi/uutiset/v1/recent.rss?publisherIds=YLE_UUTISET)
+- [HS uutiset](https://www.hs.fi/rss/tuoreimmat.xml)
+- [Iltalehti](https://www.iltalehti.fi/rss/rss.xml)
+
+ja listaa uutiset allekkain näyttäen otsikon, uutiskuvan, julkaisuajankohdan
+sekä julkaisijan. Uutista voi klikata, jolloin uutinen avautuu uuteen ikkunaan ja sen 
+voi lukea kokonaisuudessaan. Päänäkymässä olevasta napista voi päivittää uutislistauksen.
+Pyyhkäisemällä vasemmasta sivusta voi avata asetussivuston.
+
+## Release paketin asennus 
+
+Sovelluksen [apk-paketti](https://gitlab.utu.fi/hemhal/RssReaderApp/-/tree/master/app%2Frelease) ladataan ensin puhelimeen ja kun paketin avaa, niin se asentuu.
+
+## Debug asennus
+
+Kloonaa projekti itsellesi ja asenna tai käynnistä haluamassasi ohjelmassa. Sovellus 
+käyttää gradlea pakkaamiseen ja asennukseen.
+Projektin voi asentaa ja käynnistää esimerkiksi  projektin juuressa komentoriviltä (Linux):
+
+```shell
+./gradlew installDebug
+```
+Sovellus käynnistyy ennalta määriteltyyn emulaattoriin tai kytkettyyn laitteeseen.
+Suosittelen avaamaan projekti Android Studiossa ja käyttää sen työkaluja. 
+Lisää android- sovellusten [asentamisesta](https://developer.android.com/studio/run).
-- 
GitLab