Шаблон README.md файла для моих репозиториев - взят из проекта https://github.com/jtprogru/py-tg-moder/

README.md

project-reponame

Различные бэйджики <-->

Описание проекта <-->

Бот-модератор для чата @jtprgoru_chat

Умеет пока не так много, но начало положено.

Documentation

Документация <-->

Вся документация, а так же основные "хотелки на перспективу" фиксируются в Wiki этого проекта.

Environment Variables

Переменные окружения <-->

Перед запуском создать файлик src/.env с содержимым:

export TELEGRAM_BOT_TOKEN='1234567890:qwertyuiopHGVBNVJHVJVMNBVMNBVposdfghi'
export VERSION=0.1.2
export SENTRY_DSN="https://[email protected]/1234567"

Run locally

Как запустить локально <-->

Развернут на домашнем Docker Swarm через Portainer. Запустить с помощью docker compose up -d:

---
version: '3.7'
services:
  bot:
    image: ghcr.io/jtprogru/py-tg-moder:latest
    env_file:
      - ./src/.env

Feedback

Куда засунуть свой фидбэк <-->

Если случилось так, что ты начал использовать и у тебя есть фидбэк, пожалуйста создай issues или обратись в Telegram-чат jtprogru_chat).

Authors

Кто автор/ы проекта и контакты <-->

• Michael Savin
  • @jtprogru
  • 🐦 @jtprogru
  • 💰 savinmi.ru

License

Ссылка на лицензию <-->