nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 13:17:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add rust info to the README

Browse Source
This commit is contained in:
Will Hunt 2021-11-21 13:21:37 +00:00
parent 5bdd5c40ca
commit 10c21552e1
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -8,15 +8,17 @@ This bridge enables users to join Github issues and PRs through Matrix and colla
## Setup
This bridge requires at least Node 12, and Rust installed. If you do not have rust, https://rustup.rs/ is the quickest way to get it.
To set up the bridge, simply clone this repository.
` git clone git@github.com:Half-Shot/matrix-github.git`
then you will need to install dependencies
then you will need to install the dependencies
```bash
cd matrix-github
npm i # Or "yarn"
yarn # Or "yarn"
```
Then you will need to copy the `config.sample.yml` to a new file called `config.yml`. You should fill this in. Pay **close** attention to settings like `passkey` which are required for the bridge to function.