Merge pull request #22 from JavaBy/feature/docs

Add some docs

Author: madhead

.deploy/README.adoc

@@ -0,0 +1,8 @@
+= .deploy / AWS Lambda
+
+A https://aws.amazon.com/cdk[CDK] script to deploy the bot into a serverless environment:
+
+* https://aws.amazon.com/api-gateway[API Gateway] is used as an HTTP ingestor
+* The webhook is implemented as an https://aws.amazon.com/lambda[AWS Lambda]
+* https://aws.amazon.com/dynamodb[DynamoDB] is used for data storage
+* https://aws.amazon.com/step-functions[Step Functions] are used for scheduling things in future

.deploy/lambda/README.adoc

@@ -0,0 +1,22 @@
+= https://t.me/jprof_by_bot[@jprof_by_bot]
+
+Official Telegram bot of Java Professionals BY community.
+
+== What is this bot for?
+
+* Tracks http://openjdk.java.net/jeps/0[JEPs] popularity 
+* Tracks popularity of YouTube videos from Java-related channels 
+* Warns users when they mention Kotlin
+* Allows users to pin messages
+* Allows users to create polls with reply buttons (just like https://t.me/like[`@like`] bot)
+
+So, it just brings some fun and interactivity in our chat.
+
+== Contributing
+
+Here are the most important rules if you want to make a contribution:
+
+* Split the code into modules based on features
+* Stick to the technologies that can fit into AWS free tier
+
+The rest could be found in link:./.github/CONTRIBUTING.md[the contributing guide].

.github/CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 Before you begin:
 
-- This project is powered by [Kotlin](https://kotlinlang.org), [AWS](https://aws.amazon.com), [TypeScript](https://www.typescriptlang.org) and [GitHub Actions](https://github.com/features/actions).
+- This project is powered by [Kotlin](https://kotlinlang.org), [TelegramBotAPI](https://github.com/InsanusMokrassar/TelegramBotAPI), [Koin](https://insert-koin.io), and [Skija](https://github.com/JetBrains/skija) libraries, [AWS](https://aws.amazon.com) services and [CDK](https://aws.amazon.com/cdk) with [TypeScript](https://www.typescriptlang.org), and [GitHub Actions](https://github.com/features/actions).
 - Have you read the [code of conduct](CODE_OF_CONDUCT.md)?
 - Check out the [existing issues](https://github.com/JavaBy/jprof_by_bot/issues).
 - Discuss your plans in [the chat](https://t.me/jprof_by) or in an issue.

.gitignore

@@ -2,3 +2,5 @@
 build
 
 .idea
+
+*.private.env.json

README.adoc

@@ -1,3 +1,22 @@
 = https://t.me/jprof_by_bot[@jprof_by_bot]
 
 Official Telegram bot of Java Professionals BY community.
+
+== What is this bot for?
+
+* Tracks http://openjdk.java.net/jeps/0[JEPs] popularity
+* Tracks popularity of YouTube videos from Java-related channels
+* Warns users when they mention Kotlin
+* Allows users to pin messages
+* Allows users to create polls with reply buttons (just like https://t.me/like[`@like`] bot)
+
+So, it just brings some fun and interactivity in our chat.
+
+== Contributing
+
+Here are the most important rules if you want to make a contribution:
+
+* Split the code into modules based on features
+* Stick to the technologies that can fit into AWS free tier
+
+The rest could be found in link:./.github/CONTRIBUTING.md[the contributing guide].

core/README.adoc

@@ -0,0 +1,13 @@
+= Core
+
+The core of the bot is a https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern[chain-of-responsibility pattern].
+There are only two classes here:
+
+- link:src/main/kotlin/by/jprof/telegram/bot/core/UpdateProcessor.kt[`UpdateProcessor`], a stand-alone… https://tgbotapi.inmo.dev/docs/dev.inmo.tgbotapi.types.update.abstracts/-update/index.html[`Update`] processor.
+All user-facing features are implemented via them.
+Update processor should only process the updates it knows about and filter out everything else.
+- link:src/main/kotlin/by/jprof/telegram/bot/core/UpdateProcessingPipeline.kt[`UpdateProcessingPipeline`], a set of registered update processors + dispatching logic.
+All the incoming updates (the bot listens for every message in a chat) are passed to the pipeline.
+The pipeline dispatches the updates asynchronously to the registered update processors and handles timeouts and exceptions from them.
+
+image::docs/core.svg[]