docs: update readme
This commit is contained in:
parent
b172787da1
commit
0cee1b8037
1 changed files with 20 additions and 5 deletions
25
README.md
25
README.md
|
@ -73,11 +73,11 @@ learn more: [guide](https://mtcute.dev/guide/)
|
||||||
|
|
||||||
## features
|
## features
|
||||||
|
|
||||||
- 🍰 **simple**: mtcute hides all the complexity and provides a clean and modern API
|
- 🍰 **simple**: mtcute hides all the complexity and provides a clean and modern api
|
||||||
- ✨ **compatible**: mtcute supports almost everything Bot API does, and even more!
|
- ✨ **compatible**: mtcute supports almost everything bot api does, and even more!
|
||||||
- 🍡 **lightweight**: Running instance uses less than 50 MB of RAM.
|
- 🍡 **lightweight**: running instance uses less than 50 mb of ram
|
||||||
- 🛡️ **type-safe**: Most of the APIs (including MTProto) are strictly typed to help your workflow
|
- 🛡️ **type-safe**: most of the apis (including mtproto) are strictly typed to help your workflow
|
||||||
- ⚙️ **hackable**: Almost every aspect of the library is customizable, including networking and storage
|
- ⚙️ **hackable**: almost every aspect of the library is customizable, including networking and storage
|
||||||
- 🕙 **up-to-date**: mtcute uses the latest TL schema to provide the newest features as soon as possible
|
- 🕙 **up-to-date**: mtcute uses the latest TL schema to provide the newest features as soon as possible
|
||||||
|
|
||||||
## cat in the readme 🐈
|
## cat in the readme 🐈
|
||||||
|
@ -86,6 +86,21 @@ learn more: [guide](https://mtcute.dev/guide/)
|
||||||
<img src="https://cataas.com/cat" align="center" width="480" />
|
<img src="https://cataas.com/cat" align="center" width="480" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
## project goals
|
||||||
|
|
||||||
|
mtcute strives to:
|
||||||
|
- be customizable enough to fit most of the possible use-cases
|
||||||
|
- be lightweight, both in terms of runtime and bundle size
|
||||||
|
- support (theoretically) any environment without much hassle
|
||||||
|
- provide a solid foundation for all kinds of applications on telegram platform
|
||||||
|
- provide a convenient high-level api for the most commonly used features
|
||||||
|
|
||||||
|
mtcute is **NOT** and will never be:
|
||||||
|
- a library for spam/flood or otherwise malicious activities
|
||||||
|
- a fully feature-complete library - highlevel apis will never cover the entirety of the apis. feel free to contribute, though!
|
||||||
|
- a drop-in replacement for (insert library name)
|
||||||
|
- a teapot
|
||||||
|
|
||||||
## setting up for development
|
## setting up for development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
Loading…
Reference in a new issue