Skip to content

Commit

Permalink
Update package description
Browse files Browse the repository at this point in the history
  • Loading branch information
TiagoDanin committed Sep 20, 2018
1 parent dd9ff6f commit cb654c4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Telegraf Test

Telegraf Test - Simple Test Framework of Telegram Bots
Telegraf Test - Simple Test ToolKit of Telegram Bots

## Features

- Compatible with [Telegraf](http://telegraf.js.org) <3.
- Send message, inline query and callback query.
- Work in local network.

## Installation

Expand Down Expand Up @@ -42,7 +48,6 @@ test.setUser({
}*/

bot.hears(/ping/i, (ctx) => {
console.log('------')
ctx.reply('Pong!')
})

Expand All @@ -61,10 +66,14 @@ test.sendMessageWithText('/ping')

### Options of Class `TelegrafTest({options})`

**url** - String
- **url** - String
> Webhook url of your bot.</br>
> Default value: `http://127.0.0.1:3000/secret-path`
- **axios** - Object
> Config/option of Axios.</br>
> Default value: `{headers: {'content-type': 'application/json'}, method: 'POST'}`
### API

#### Set & Get Objects
Expand Down
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "telegraf-test",
"version": "0.0.1",
"description": "Telegraf Test - Simple Test Framework of Telegram Bots",
"version": "1.0.0",
"description": "Telegraf Test - Simple Test ToolKit of Telegram Bots",
"main": "index.js",
"dependencies": {
"axios": "0.18.0",
Expand All @@ -22,7 +22,8 @@
"telegraf",
"test",
"telegram",
"framework"
"framework",
"toolkit"
],
"author": "Tiago Danin",
"license": "MIT",
Expand Down

0 comments on commit cb654c4

Please sign in to comment.