From 10443d75839aa760fec34ff50662ea161268b568 Mon Sep 17 00:00:00 2001 From: brainrepo Date: Sat, 2 Oct 2021 22:30:01 +0200 Subject: [PATCH] docs: readme update --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d2a9f2..7d26917 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,24 @@ > Turn your telegram community links into a newsletter -TODO: insert here a readme +Telegram communities and groups based on messaging systems have a tremendous limit, interesting links are often flooded by tons of messages with less importance. +Once submerged the life of the link, regardless of the importance it has, is finished. + +## How to solve this problem? + +The solution that we thought of is to store all the messages that contain a link, and once a week, automatically generate an email and send it to subscribers. + +Simple no 😜! + +## Architecture + +Botletter is a nodejs application written in typescript. + +The application is divided into core and infrastructure. + +**Core**: contains all the business logic of the application + +**Infrastructure**: since botletter not matters about the service we use to store messages and send email this folder contains the delivery and the store modules. ## Notes