mtcute/packages/mtproxy/README.md
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

20 lines
341 B
Markdown

# @mtcute/mtproxy
![](./coverage.svg)
MTProto proxy (MTProxy) transport for mtcute.
## Usage
```typescript
import { MtProxyTcpTransport } from '@mtcute/mtproxy'
const tg = new TelegramClient({
// ...
transport: () => new MtProxyTcpTransport({
host: 'localhost',
port: 443,
secret: 'secret'
})
})
```