Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hinto-janai committed Jun 23, 2024
1 parent 2e2be1a commit f3ebeb0
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ chmod -R 700 ~/.config/moo/ # user-only permissions
```

### 3. Add correct `@moo:monero.social` password to `moo.toml`
If you don't want to save a password unencrypted to disk, set this environment variable:
If you don't want to save a password unencrypted to disk, set this environment variable (leading with a space):
```bash
MOO_PASSWORD="$correct_password"
# There's a space leading this command so
# it isn't saved in your shell's history file.
MOO_PASSWORD="$correct_password" ./moo
```

### 4. Start
Expand Down Expand Up @@ -98,4 +100,11 @@ For configuration, see [`moo.toml`](moo.toml).
| Config | `~/.config/moo/moo.toml`

## Forking
TODO
`moo` is hardcoded for Cuprate but it _probably_ works with any account in any room, just edit these [constants](https://github.com/Cuprate/moo/blob/2e2be1abecfac8c75a5a1942dae1f40d880f4756/src/constants.rs):
- [`MOO_MATRIX_ID`](https://github.com/Cuprate/moo/blob/2e2be1abecfac8c75a5a1942dae1f40d880f4756/src/constants.rs#L62-L64) (your bot's username)
- [`CUPRATE_GITHUB_PULL`](https://github.com/Cuprate/moo/blob/2e2be1abecfac8c75a5a1942dae1f40d880f4756/src/constants.rs#L18)
- [`CUPRATE_GITHUB_PULL_API`](https://github.com/Cuprate/moo/blob/2e2be1abecfac8c75a5a1942dae1f40d880f4756/src/constants.rs#L21)
- [`CUPRATE_MATRIX_ROOM_ID`](https://github.com/Cuprate/moo/blob/2e2be1abecfac8c75a5a1942dae1f40d880f4756/src/constants.rs#L53-L55)
- [`ALLOWED_MATRIX_IDS_DEFAULT`](https://github.com/Cuprate/moo/blob/2e2be1abecfac8c75a5a1942dae1f40d880f4756/src/constants.rs#L78-L85)

and remove the `allowed_users` in `moo.toml`.

0 comments on commit f3ebeb0

Please sign in to comment.