From 6dc04929e6b8257e2c5d11eb35cdb64de8b743f7 Mon Sep 17 00:00:00 2001 From: GeekSpark Date: Tue, 18 Aug 2020 10:34:35 +0530 Subject: [PATCH 1/3] Update README.md There was a typo mistake in INDEX_SETTINGS JSON. aA ',' was missing. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d3c2e4..eed34a9 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ This is the general format, change the values for corresponding fields as your r "index_private":false, "index_group": false, "index_channel": true, - "exclude_chats": [] + "exclude_chats": [], "include_chats": [], } ``` From ee87506f90ea138c3c754a08c17323633938d4df Mon Sep 17 00:00:00 2001 From: Justin Thomas <57831354+justinthoms@users.noreply.github.com> Date: Wed, 19 Aug 2020 09:19:16 +0530 Subject: [PATCH 2/3] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5d3c2e4..70eb00b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Telegram Index > Python Web App which indexes a telegram channel(or a chat) and serves its files for download. +[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/odysseusmax) +[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html) ## Overview From a2bc3c9398f7900fc42efeef36e986619995444d Mon Sep 17 00:00:00 2001 From: Christy Roys Date: Thu, 20 Aug 2020 10:52:08 +0530 Subject: [PATCH 3/3] Update README.md --- README.md | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 68cd10a..fc2dd3b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ # Telegram Index > Python Web App which indexes a telegram channel(or a chat) and serves its files for download. -[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](https://github.com/odysseusmax) -[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html) -## Overview +[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.png?v=103)](.) [![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE) -* This app indexes all the available messages. -* If the message is a media message, you can download the file. -* You can search for specific terms too. +## Highlights + +* Index one or more telegram channels/chats. +* View messages and media files on the browser. +* Search through the channel/chat. +* Download media files through browser/download managers. ## Demo -Hosted demo site: https://tg-index-demo.herokuapp.com/ +Hosted demo site: https://tg-index-demo.herokuapp.com ## Deploy Guide @@ -51,7 +52,7 @@ $ pip3 install -U -r requirements.txt * **Setting value for `INDEX_SETTINGS`** -This is the general format, change the values for corresponding fields as your requirements. +This is the general format, change the values of corresponding fields as your requirements. ``` { @@ -63,12 +64,12 @@ This is the general format, change the values for corresponding fields as your r "include_chats": [], } ``` -* `index_all` - Whether to consider all the chats associated with the telegram account. Value should either be `true` or `false`. -* `index_private` - Whether to index private chats. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. -* `index_group` - Whether to index group chats. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. -* `index_channel` - Whether to index channels. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. -* `exclude_chats` - An array/list of chat id's that should be ignored for indexing. Only considered if `index_all` is set to `true`. -* `include_chats` - An array/list of chat id's to index. Only considered if `index_all` is set to `false`. +> * `index_all` - Whether to consider all the chats associated with the telegram account. Value should either be `true` or `false`. +> * `index_private` - Whether to index private chats. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. +> * `index_group` - Whether to index group chats. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. +> * `index_channel` - Whether to index channels. Only considered if `index_all` is set to `true`. Value should either be `true` or `false`. +> * `exclude_chats` - An array/list of chat id's that should be ignored for indexing. Only considered if `index_all` is set to `true`. +> * `include_chats` - An array/list of chat id's to index. Only considered if `index_all` is set to `false`. * **Run app.** @@ -77,15 +78,11 @@ This is the general format, change the values for corresponding fields as your r $ python3 -m app ``` -* Other quick methods. +* **Other quick methods.** -[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/odysseusmax/tg-index/tree/master) [![Run on Repl.it](https://repl.it/badge/github/odysseusmax/tg-index)](https://repl.it/github/odysseusmax/tg-index) +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/odysseusmax/tg-index/tree/master) [![Run on Repl.it](https://repl.it/badge/github/odysseusmax/tg-index)](https://repl.it/github/odysseusmax/tg-index) -## Video Tutorial - -Here's a YouTube tutorial video for deploying to [Heroku](https://heroku.com/ "Heroku"). [Video Link](https://youtu.be/V8MKM6yzydw "Tutorial video for deploying to Heroku") - ## Contributions Contributions are welcome.