From ff48c1b5a7aaac1a8ea140249c2c1a40be5f3daa Mon Sep 17 00:00:00 2001
From: Ville Komulainen <ville.m.komulainen@utu.fi>
Date: Wed, 27 Apr 2022 10:25:31 +0000
Subject: [PATCH] Add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d1cfdb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+Simple web-scraper for finnish news sites "yle.fi" and "iltalehti.fi"
+20-30 or so of the most recent stories will be scraped from either site
+The data will be compiled to json format and one news story will contain the publication date, the title for the story and the actual text.
+
+Build:
+install required libraries with -pip install -r requirements.txt
+
+Run:
+Run with -python src/main/main.py 
+
+-You will be asked which news site you want to scrape the data from
+-Write into the prompt either "yle" or "iltalehti" 
+-Next you will be asked to name the file that the json data will be stored into
+-File will appear in the root of the project
-- 
GitLab