History

teidesu 390b65f796 build(docs): api reference generation improvements - 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		2022-08-24 23:37:26 +03:00
..
index.ts	refactor: prettier-ed code, rearranged imports, fixed tests	2022-06-30 16:32:56 +03:00
package.json	build(docs): api reference generation improvements	2022-08-24 23:37:26 +03:00
README.md	build(docs): api reference generation improvements	2022-08-24 23:37:26 +03:00
tsconfig.json	build(docs): api reference generation improvements	2022-08-24 23:37:26 +03:00
typedoc.js	build(docs): api reference generation improvements	2022-08-24 23:37:26 +03:00

README.md

@mtcute/node

All-in-one package for NodeJS. Includes support for native crypto addon (must be installed separately, @mtcute/crypto-node), terminal I/O via readline and comes with pre-installed HTML and Markdown parsers.

Note

@mtcute/client. For full documentation, see @mtcute/client docs.

Usage

import { NodeTelegramClient } from '@mtcute/node'

const tg = new NodeTelegramClient({
    apiId: 12345,
    apiHash: 'abcdef',
    storage: 'client.session'
})