Browse Source

Add README.

master
Syfaro 1 year ago
parent
commit
427135db67
1 changed files with 25 additions and 0 deletions
  1. 25
    0
      README.md

+ 25
- 0
README.md View File

@@ -0,0 +1,25 @@
1
+# telegram-previous-images
2
+
3
+Uses a perceptual image hash to determine if a message has already been sent
4
+within a group chat.
5
+
6
+Data is stored in Bolt. It records the image hash and the original Message.
7
+
8
+## Configuration
9
+
10
+The following environment variables must be set:
11
+* `TELEGRAM_APITOKEN` - Telegram token from Botfather
12
+* `TELEGRAM_DEBUG` - If tgbotapi should print debugging messages (true/false)
13
+* `BOLT_DBNAME` - Filename for Bolt database file
14
+
15
+## Usage
16
+
17
+After starting, add it to your chat. After setting a threshold to report on by
18
+using the command `/threshold num` where `num` is the threshold value on a range
19
+of 0 being idential to any higher number (15 is a good starting point), it will
20
+start indexing photos sent. If a photo matches a previous photo within the
21
+threshold, it will reply to the old message with the similarity.
22
+
23
+It currently supports loading photos, documents, and URLs that link directly to
24
+an image. Hopefully in the future sites will be added to allow it to work
25
+somewhat with links that aren't directly images.

Loading…
Cancel
Save