Skip to content

Commit 9c3addb

Browse files
author
Marc Richter
committed
Added README content
1 parent 05290b2 commit 9c3addb

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

README.md

+50-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1-
# python_telegram_bot
2-
This repo contains code to be used with my article series "Create your own Telegram bot with Django on Heroku" available at https://www.marc-richter.info/series/create-your-own-telegram-bot-with-django-on-heroku/
1+
# About this Repository
2+
3+
This repo contains code to be used as "follow along" - resource for my article series
4+
"Create your own Telegram bot with Django on Heroku" available at my Blog at
5+
https://www.marc-richter.info/series/create-your-own-telegram-bot-with-django-on-heroku/.
6+
7+
# How should I use it?
8+
9+
After each article, I will add the essence of that article and add it to this repository.
10+
The changes can then be found in the repositories commit history and allows to easily
11+
check what has been changed.
12+
13+
To make it even more easy to find the state for the actual chapter you are trying to work
14+
with, I will add two Git Tags per chapter:
15+
16+
* partX_start
17+
* partX_end
18+
19+
With "X" replaced by the corresponding article from the Blog.
20+
I consider the names quite self explanatory.
21+
22+
# Q: I'm just noticing this with Part 11 - How comes I never noticed this before?
23+
24+
The answer is quite easy: This repo did not exist when I wrote the first 10 parts of the
25+
article series.
26+
27+
# Q: Why did you decide to create this repo now?
28+
29+
I started this article series back in August 2018. I never
30+
intended it to grow larger than 2-3 articles. After I started writing it, I quickly found
31+
myself with more and more parts filling quite long article pages (from an SEO perspective:
32+
Too long) with quite high-dense content without an end in sight even after Part 10.
33+
34+
I have to admit, that I completely underestimated the amount of stuff which is important to
35+
mention in a series which should be catchy and easy to understand for audiences of all
36+
levels of experience. Quite much of what has turned _obvious_ and "_not worth to mention
37+
explicitly_" to me (with my own Python skills evolving over time), could lead to a beginner
38+
not being able to follow. I read many articles myself that lost me even though I wanted
39+
to understand them really bad, but I just could not follow along and connect the dots when
40+
large parts, which were considered too obvious to mention for an intermediate reader, were
41+
just missing, leading to a gap between the parts I just wasn't able to close myself.
42+
43+
Also, Part 10 has been published in December 2018. It wasn't before August 2020 that I
44+
continued the series, due to change of jobs and a high amount of work that came along with
45+
it.
46+
47+
This huge pause was the main reason I had the idea for this repository. I wanted to
48+
have something that makes re-entry to the series for people, who haven't heard from it
49+
for far longer than 18 months (and most certainly forgot about most of the code we
50+
discussed), and readers, who hop on in Part 11 only, easier to adapt.

0 commit comments

Comments
 (0)