mtcute/README.md

MTCute

Work-in-progress library for MTProto in TypeScript.

🎯 Roadmap (notion.so)

⚠️ Warning: While this library is WIP, storage format will change without changing format version and without migration algorithm.

If you encounter errors related to this, either reset your storage by removing the file, or fix it manually.

What currently works:

• TCP Connection in NodeJS
• Sending & receiving text messages
• Uploading & downloading files
• HTML & Markdown parse modes
• Type-safe filter system

What is not done yet:

• pretty much everything else

Setting up for development:

git clone https://github.com/teidesu/mtcute
cd mtcute
yarn install
npx lerna link

Acknowledgements

Some parts were based on code from these projects:

• Pyrogram
• Telethon
• TDesktop