Skip to content

Updated readme.md #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brabo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated readme.md #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@

A Deltachat-bot which works as bridge between Deltachat and Github Webhoooks

### Dependencies
- libclang-dev
- Rust

### Installation
We use a local Rust install. You can install that like:
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > rustup-init.sh
sh rustup-init.sh -y
rm rustup-init.sh
```

Enable the Rust environment:
```
. .cargo/env
```

After that you can clone the repo:
```
git clone https://github.com/Septias/deltachat-github-bot.git
```

And subsequently run the bot, which the first run will install the required Rust dependencies:
```
addr=<email-address> mail_pw=<email-password> cargo r
```

### Usage

Users can interact with the bot by issuing `commands`.
Expand Down Expand Up @@ -118,7 +145,7 @@ gh repositories list
```

### Development
Start the bot like this:
Start the bot like this:
```
RUST_LOG=info addr=<add> mail_pw=<pw> cargo r
```
Expand All @@ -130,7 +157,6 @@ It comes in handy to send webhook-events manually with curl:
curl -X POST --data "mock/issue_open.json" localhost:8080/receive --header "X-GitHub-Event: issues"
```


### Further improvement

- Don't allow users to register listeners twice
Expand Down