diff --git a/README.md b/README.md index e88b736..7a12fd8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # karma A [maubot](https://github.com/maubot/maubot) that tracks the karma of users. + +``` +Usage: !karma [...] + +up - Upvote an event +down - Downvote a message +stats - View global karma statistics +view [user ID] - View your or another users karma +export - Export the data of your karma +breakdown - View your karma breakdown +top - View the highest rated users +bottom - View the lowest rated users +best - View the highest rated messages +worst - View the lowest rated messages +```