Fijxu/justlog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #192 from bathtubdev/main

Browse source 
readme grammar fixes
This commit is contained in:
gempir 2023-03-11 17:22:43 +01:00 • committed by GitHub
commit e01da40bea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.MD
View file

@ -1,11 +1,11 @@
# justlog [![Build Status](https://github.com/gempir/justlog/workflows/ci/badge.svg)](https://github.com/gempir/justlog/actions?query=workflow%3Aci)
### What is this?
Justlog is an twitch irc bot. It focuses on logging and providing an api for the logs.
Justlog is a twitch irc bot. It focuses on logging and providing an api for the logs.
### Optout
Click the X icon on the web ui to find a explanation how to opt out.
Click the X icon on the web ui to find an explanation for how to opt out.
### API
@ -23,11 +23,11 @@ docker run -p 8025:8025 --restart=unless-stopped -v $PWD/config.json:/etc/justlo
Only admins can use these commands
- `!justlog status` will respond with uptime
- `!justlog join gempir pajlada` will join the channels and append them to the config
- `!justlog part gempir pajlada` will part the channels and remove them from the config
- `!justlog optout gempir gempbot` will opt out users of message logging or querying previous logs of that user, same applies to users own channel
- `!justlog optin gempir gempbot` will revert the opt out
- `!justlog status` will respond with uptime.
- `!justlog join gempir pajlada` will join the channels and append them to the config.
- `!justlog part gempir pajlada` will part the channels and remove them from the config.
- `!justlog optout gempir gempbot` will opt out users of message logging or querying previous logs of that user. the same applies to a user's own channel.
- `!justlog optin gempir gempbot` will revert the opt out.
### Config