diff --git a/README.md b/README.md index c0ba110..fe776a4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # Anonymous Kitten -Anonymous Kitty is our project, which was implemented thanks to the IT activist Nika in MOST. The project was generally needed to implement safe and anonymous communication with the wave-dwellers queer media MOST. \ No newline at end of file +Anonymous Kitty is our project, which was implemented thanks to the IT activist Nika in MOST. The project was generally needed to implement safe and anonymous communication with the wave-dwellers queer media MOST. + +# telegram topic's bot: +It helps to communicate with subscribers anonymously: +User will write to bot. +You and other admins (if needed) will see messages in your channel. +Each user = topic in your channel. +!!! Do not create and delete new topics manually. + + + +Before hand you need to: +1. create channel with topics +2. create bot in telegram +3. male bot admin in channel allowing to create new topics +4. create database +5. create .env file and set 4 variables: +- BOT_TOKEN = bot token from telegram +- GROUP_ID = id of your channel +- DATABASE_URL = address of your database +- TABLE_NAME = name of your table in database ( + CREATE TABLE table name here ( + id SERIAL PRIMARY KEY, + telegram_id BIGINT NOT NULL, + anon_id UUID NOT NULL, + created_at TIMESTAMP DEFAULT NOW() + topic_id INTEGER NOT NULL +) +6. connect database to bot by setting needed variables +6. run bot +7. enjoy \ No newline at end of file