Skip to content

Commit 596ac09

Browse files
committed
docs: update the README.md
Signed-off-by: saltbo <saltbo@foxmail.com>
1 parent 29d2621 commit 596ac09

File tree

2 files changed

+32
-18
lines changed

2 files changed

+32
-18
lines changed

README.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,23 @@ It was a generic webhook endpoint to call some notifications.
1818

1919
## Non-Features
2020

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.
2423

2524
## Getting Started
2625

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
2838

2939
```yaml
3040
apiVersion: github.com/bonaysoft/gofbot/v1alpha1
@@ -44,16 +54,7 @@ spec:
4454
hello: {{ .other.key }}
4555
```
4656
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
5758
5859
Chat with your robot and get the webhook address.
5960
@@ -78,3 +79,19 @@ curl -X POST -H "Content-Type: application/json" -d '{"type": "xxCreate", "name"
7879
- [ ] DingTalk
7980
- [ ] WeCom
8081

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.

docker-compose.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
services:
22
gofbot:
3-
build:
4-
context: .
5-
dockerfile: Dockerfile
6-
# image: bonaysoft/gofbot:latest
3+
image: bonaysoft/gofbot:latest
74
command:
85
- --adapter
96
- telegram

0 commit comments

Comments
 (0)