Skip to content

Commit

Permalink
Merge pull request #6 from web-pacotes/4-docs-usage-and-features
Browse files Browse the repository at this point in the history
docs: usage and features
  • Loading branch information
rutesantos4 authored Jun 14, 2023
2 parents e3d476d + 65882d4 commit 77329f8
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,28 @@ Logs messages to a Telegram channel

## How to use

todo: describe usage
To use this package, you will need a Telegram BOT and a Telegram group chat.

```typescript
todo: include usage code here
```
import { default as handler, TelegramOptions } from 'telegram-log';

## Features
async function main() {
const telegramOptions = <TelegramOptions>{
botToken: 'your-telegram-bot-token',
chatId: 'you-telegram-chat-id'
};

const result = await handler('Hello from telegram-log!!!', telegramOptions);

todo: enumerate features package currently provides
console.log(result);
}

main();
```

## Missing features
## Features

todo: enumerate features package does not provide
- Sends a message to a Telegram group chat.

---

Expand Down Expand Up @@ -58,12 +67,3 @@ Found any bug (including typos) in the package? Do you have any suggestion
or feature to include for future releases? Please create an issue via
GitHub in order to track each contribution. Also, pull requests are very
welcome!

### Contact

This template was prepared by:

- João Freitas, @freitzzz
- Rute Santos, @rutesantos4

Contact us for freelancing work!

0 comments on commit 77329f8

Please sign in to comment.