https://github.com/tg-rs/carapax

A Telegram Bot API framework
https://github.com/tg-rs/carapax

rust telegram telegram-bot telegram-bot-framework

Last synced: about 2 months ago
JSON representation

A Telegram Bot API framework

• Host: GitHub
• URL: https://github.com/tg-rs/carapax
• Owner: tg-rs
• License: mit
• Created: 2019-03-23T09:57:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-07T19:57:09.000Z (4 months ago)
• Last Synced: 2024-05-18T20:43:17.849Z (4 months ago)
• Topics: rust, telegram, telegram-bot, telegram-bot-framework
• Language: Rust
• Homepage:
• Size: 33 MB
• Stars: 105
• Watchers: 5
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# CARAPAX

[![CI](https://img.shields.io/github/actions/workflow/status/tg-rs/carapax/ci.yml?branch=master&style=flat-square)](https://github.com/tg-rs/carapax/actions/)

[![Coverage](https://img.shields.io/codecov/c/github/tg-rs/carapax.svg?style=flat-square)](https://codecov.io/gh/tg-rs/carapax)

[![Version](https://img.shields.io/crates/v/carapax.svg?style=flat-square)](https://crates.io/crates/carapax)

A Telegram Bot framework based on [tgbot](https://github.com/tg-rs/tgbot).

The name comes from [Carapace](https://en.wikipedia.org/wiki/Carapace) (carapax in latin).

## Installation

```toml

[dependencies]

carapax = "0.22.0"

```

## Examples

See examples in the [examples](https://github.com/tg-rs/carapax/tree/0.22.0/examples) directory.

To run examples you need to create a `.env` file:

```sh

cp sample.env .env

```

Don't forget to change the value of `CARAPAX_TOKEN` and other variables if required.

## Versioning

This project adheres to [ZeroVer](https://0ver.org/).

## Links

- [Latest Documentation](https://docs.rs/carapax)

- [Master Documentation](https://tg-rs.github.io/carapax/carapax/)

- [Telegram Chat](https://t.me/tgrsusers)

- [Changelog](https://github.com/tg-rs/carapax/tree/0.22.0/CHANGELOG.md)

- [Code of Conduct](https://github.com/tg-rs/carapax/tree/0.22.0/CODE_OF_CONDUCT.md).

## LICENSE

The MIT License (MIT)