390b65f796
- added readme in each package - updated typedoc, fixed related issues - use @link instead of @see - moved configs to typedoc.js, improved exclusion of unneeded stuff - custom plugin for typedoc for cross-package references - preparing to move documentation to separate repository |
||
|---|---|---|
| packages | ||
| scripts | ||
| tl-reference | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| tsconfig.json | ||
| typedoc.js | ||
MTCute
PROJECT IS NOT DEAD/ABANDONED
I'm currently a bit struggling to devote enough time for it due to IRL stuff. Also due to the stuff I'm working on in the project right now, I'm not making any commits not to break stuff.
Sorry about that! Will hopefully get my hands back on it in late summer of 2022
Work-in-progress library for MTProto in TypeScript.
🎯 Roadmap (notion.so) | 📦 TL Reference
⚠️ Warning: While this library is WIP, storage format will change without changing format version and without migration algorithm, and there will be breaking changes in the API.
If you encounter errors related to storage, either reset your storage by removing the file, or fix it manually.
Installation
MTCute is currently only published in my private NPM registry.
You can install it by running:
npm config set --location project @mtcute:registry https://npm.tei.su
npm install @mtcute/node # or any other package
Setting up for development:
git clone https://github.com/mtcute/mtcute
cd mtcute
pnpm install
# generate code from tl schema
cd packages/tl
pnpm run gen-code
Acknowledgements
Some parts were based on code from these projects: