From 4bb3aff513740c29604a5d50fa16145746333645 Mon Sep 17 00:00:00 2001
From: la-ninpre <leobrekalini@gmail.com>
Date: Tue, 17 Nov 2020 14:24:57 +0300
Subject: add readme

Some raw and crappy documentation.
---
 README.md          |  43 +++++++++++++++++++++++++++++++++++++++++++
 docs/tg-export.png | Bin 0 -> 38418 bytes
 parse.py           |   7 -------
 3 files changed, 43 insertions(+), 7 deletions(-)
 create mode 100644 README.md
 create mode 100644 docs/tg-export.png

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2eb604e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# telegram2md
+
+This script parses output from Telegram channel and converts each post to 
+jekyll-applicable post in markdown.
+
+Telegram Desktop creates JSON file, as well as different directories containing
+multimedia, photos, etc. This script creates new directory and populates it with
+formatted posts ready to publish.
+
+## basic usage
+
+Firstly you need to export your channel history from Telegram Desktop app.
+This could be done from three dots menu. Then popup menu appears, where
+you can choose what data you want to export. The script currently supports
+only photos, voice messages and audio files.
+
+![tg-export](docs/tg-export.png)
+
+In format menu you should specify 'Machine-readable JSON' file and then
+locate to directory of your desire.
+
+To convert your posts to markdown files you need to copy `parse.py` file into
+your export folder and run it there.
+
+```console
+$ cp parse.py /path/to/export/dir
+$ cd /path/to/export/dir
+$ python parse.py
+```
+
+Currently there's no way to change name of ouput folder other than directly
+editing the script. By default it's creating directory `formatted_posts` with
+markdown files in there.
+
+Also if your jekyll directory storing media files in folders other than `photos`
+and `files`, you should change `photo_dir` and `media_dir` variables.
+
+## todo's
+
+- replies
+- single/muliple tags
+- forwarded posts
+- custom post header
diff --git a/docs/tg-export.png b/docs/tg-export.png
new file mode 100644
index 0000000..94b45a3
Binary files /dev/null and b/docs/tg-export.png differ
diff --git a/parse.py b/parse.py
index 4a768d0..7f6c8a2 100644
--- a/parse.py
+++ b/parse.py
@@ -1,12 +1,5 @@
 #!/usr/bin/env python
 
-# This script parses output from Telegram channel and converts each post to 
-# jekyll-applicable post in markdown.
-#
-# Telegram creates result.json file, as well as different directories containing
-# multimedia, photos, etc. This script creates new directory and populates it 
-# with formatted posts ready to publish.
-#
 # TODO summary:
 # - replies
 # - single/muliple tags
-- 
cgit v1.2.3