aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAryadev Chavali <aryadevchavali1@gmail.com>2019-02-02 12:55:26 +0000
committerAryadev Chavali <aryadevchavali1@gmail.com>2019-02-02 12:55:26 +0000
commit2484f1392b0247e7e7b9509cbacc19d5e830960c (patch)
tree9ee3c2ff905b9e8100b457460cc4235291329d99 /README.md
parentdfb3de7b69b43e5d30d88230f2ed18842da8ba30 (diff)
downloadnewsaggregator-2484f1392b0247e7e7b9509cbacc19d5e830960c.tar.gz
newsaggregator-2484f1392b0247e7e7b9509cbacc19d5e830960c.tar.bz2
newsaggregator-2484f1392b0247e7e7b9509cbacc19d5e830960c.zip
Added details to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5d3252f..22323ff 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
# NewsAggregator
-A news article aggregator using RSS feeds.
+
+A news article aggregator using RSS feeds to extract articles from differing sources. These aggregated articles are displayed on a website for the user to see.
+
+## In-depth
+
+Articles will extracted from an RSS Feed (which is in a XML format) via a C# application, which will put each articke into standard CLR objects. These CLR objects will then be committed to a database for persistence even when the server is off. While the database is periodically updated, a web server will display articles from the database to the user in a nice format.
+
+This therefore provides a clear distinction between the frontend and the backend:
+
+* Aggregator of articles (purely backend)
+* Database (purely backend)
+* Web server (backend funnel to frontend)
+* Web page (purely frontend)
+
+## Languages and services used
+
+* C# for the aggregator
+* C#/Node.js for the web server
+* MySQL for the database