@@ -18,13 +18,23 @@ It was a generic webhook endpoint to call some notifications.
18
18
19
19
## Non-Features
20
20
21
- - One robot connect to multiple chat platform, your should use multiple robots
22
- - Message persistence is not supported and messages are not guaranteed to be lost, If you cannot tolerate message loss,
23
- you should use it with the event bus
21
+ - If you want One robot connect to multiple chat platform at the same time, you should start up multiple robots.
22
+ - If you cannot tolerate message loss, you should use it with the event bus.
24
23
25
24
## Getting Started
26
25
27
- ### Step1: Write your Message
26
+ ### Step1: Install and boot your bot
27
+
28
+ > If you don't have a bot, you should create one
29
+ > first, [ see here] ( https://core.telegram.org/bots#3-how-do-i-create-a-bot ) .
30
+
31
+ ``` bash
32
+ wget https://raw.githubusercontent.com/bonaysoft/gofbot/master/docker-compose.yml
33
+ echo " TG_TOKEN=xxxx" > .env
34
+ docker-compose up
35
+ ```
36
+
37
+ ### Step2: Write your Message for your bot
28
38
29
39
``` yaml
30
40
apiVersion : github.com/bonaysoft/gofbot/v1alpha1
44
54
hello: {{ .other.key }}
45
55
` ` `
46
56
47
- ### Step2: Run the robot
48
-
49
- > If you don't have a bot, you should create one
50
- > first, [see here](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
51
-
52
- ` ` ` bash
53
- TG_TOKEN=xxx gofbot run --adapter telegram
54
- ```
55
-
56
- ### Step3: Get the webhook
57
+ ### Step2: Get the webhook
57
58
58
59
Chat with your robot and get the webhook address.
59
60
@@ -78,3 +79,19 @@ curl -X POST -H "Content-Type: application/json" -d '{"type": "xxCreate", "name"
78
79
- [ ] DingTalk
79
80
- [ ] WeCom
80
81
82
+ # # Need Helps (Welcome PRs)
83
+
84
+ - Implement more adapters
85
+ - Build more Messages into the [catalog](catalog)
86
+ - Rich the documents
87
+
88
+ # # Versioning
89
+
90
+ We use [SemVer](http://semver.org/) for versioning. For the versions available,
91
+ see the [tags on this repository][tags].
92
+
93
+ # # Authors
94
+
95
+ - **Ambor** - *Initial work* - [saltbo](https://github.com/saltbo)
96
+
97
+ See also the list of [contributors][contributors] who participated in this project.
0 commit comments