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
23 lines
606 B
Markdown
23 lines
606 B
Markdown
# @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**: documentation for this package only includes changes from
|
|
> `@mtcute/client`. For full documentation, see
|
|
> [`@mtcute/client` docs](../client/index.html).
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
import { NodeTelegramClient } from '@mtcute/node'
|
|
|
|
const tg = new NodeTelegramClient({
|
|
apiId: 12345,
|
|
apiHash: 'abcdef',
|
|
storage: 'client.session'
|
|
})
|
|
```
|