teidesu/mtcute
1
0
Fork 0
Code Issues 15 Pull requests 1 Projects Releases Packages Wiki Activity Actions

docs: updated readme

Browse source
This commit is contained in:
Alina Sireneva 2023-11-12 19:42:04 +03:00 committed by GitHub
parent 6e3394316e
commit 6ca430eb05
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -16,7 +16,7 @@
<img src="https://img.shields.io/npm/v/@mtcute/client" alt="npm" /> <img src="https://img.shields.io/npm/v/@mtcute/client" alt="npm" />
</a> </a>
<a href="https://t.me/mt_cute"> <a href="https://t.me/mt_cute">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Ftei.su%2Fmtcute_chat_badge.php&cacheSeconds=300000" alt="telegram chat" /> <img src="https://img.shields.io/endpoint?url=https%3A%2F%2Ftei.su%2Fmtcute_chat_badge.php&cacheSeconds=300" alt="telegram chat" />
</a> </a>
<img src="https://img.shields.io/badge/-alpha-orange" alt="alpha version" /> <img src="https://img.shields.io/badge/-alpha-orange" alt="alpha version" />
</p> </p>
@ -24,6 +24,8 @@
> [!WARNING] > [!WARNING]
> mtcute is currently in alpha stage: the api is not very stable yet, and there may be a lot of bugs > mtcute is currently in alpha stage: the api is not very stable yet, and there may be a lot of bugs
> feel free to try it out, though, any feedback is appreciated! > feel free to try it out, though, any feedback is appreciated!
>
> releases may not follow semver just yet, so please pin the versions for now
```ts ```ts
import { NodeTelegramClient } from '@mtcute/node' import { NodeTelegramClient } from '@mtcute/node'