Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.15 KB

README.md

File metadata and controls

59 lines (36 loc) · 1.15 KB

grammYLog

Logging plugin for the grammY framework!

Features

  1. Log messages received by your bot to console.
  2. Log message content as well as first name, last name, username and Telegram ID of the sender.
  3. Supports text and inline messages. In case of media messages, limited to captions.
  4. For the future, db integrations are possible to implement persistent logs.

Usage

Simply copy the plugin code from log.js and place it in your grammY project.

If you want to try it out first:
  1. Firstly, clone this repo.
  2. Then run npm i.
  3. Rename .env.example to .env and provide bot token.
  4. Run the example with node example/echo

Example

To use the example to see out how the plugin works:

node example/echo

Template

A template has been included to get started right away.

To use the template:

node template/template

Modify it as per your needs.

Contribute

If you'd like to contribute to the project, please read grammY's guide to plugins.

License

MIT ©️ Zubin