Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 1.53 KB

README.md

File metadata and controls

62 lines (38 loc) · 1.53 KB

Kilogramme (TBD)

RUST MPL-2.0 DOCS

High Performance MTProto Telegram Userbot

WIP

Prerequisites

Usage

cargo build --release
./target/release/kilogramme-tbd

Configuration

See config.example.toml for an example config

Refer to docs/CONFIG.md for an in-depth overview

Docker

The bot can be run with docker-compose

See docs/DOCKER.md for instructions

Contributing

See docs/CONTRIBUTING.md

FAQ

Why rust?

rust is based and I wanted proper static typing

Can I use this in production?

lol

how's the performance?

yes

To-do

Sorted by priority

  • More documentation (available commands, etc)
  • Many memez
  • Battle testing (#helpme)

Other stuff to remember

The source code has some not so safe for work stuff. It has been marked as such with a warning.
tread with caution.