Skip to content

Commit

Permalink
add README.md to the examples directory
Browse files Browse the repository at this point in the history
  • Loading branch information
Neur0toxine authored Dec 29, 2023
1 parent 9803c8d commit 173c2cc
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Usage examples

This directory contains examples on how to use the library properly. Currently two examples are available:
- [Simple Telegram transport (only text messages are supported)](telegram)
- [MG Webhook processing example](webhooks)

## `telegram`

How to run the example:
1. Copy `config.json.dist` to `config.json`.
2. Replace placeholder values in the `config.json` with your data. You'll need a service like ngrok.io for that.
3. Navigate to `telegram` directory via terminal and run `go run ./...`

The sample will automatically register itself in the target system and will begin transferring the messages between Telegram and MessageGateway.

## `webhook`

You can run this example by executing `go run /...`. Transport API webhooks from MessageGateway should be sent to the `/api/v1/webhook` route.

0 comments on commit 173c2cc

Please sign in to comment.