diff --git a/README.md b/README.md index 65bc98f..6aa772c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # discord-presence-tracker +A discord bot to track discord presence activity. It can be used, for example, as *played in different games* hours counter. +## Commands +Notes: +- `total ` usually means just sum for numeric values in output. +- `SPFR` short from *Show Position For Requested* mean in output we should show position in rating for a requested item. +- `period`, `SPFR` should be preserved between redirects + + +1. `/stats ` Gives information about hours spent in games for given user per games +or in specified game. + - Output: `Game name, spent hours`. + - Features: Pagination, total hours, total hours for page, period. + - Redirects: `Game name` -> `/top_games 'Game name'` (or /top_players?). + +2. `/top_players ` Gives information about users who spent the most time +in games or in a selected game. + - Output: `User name, spent hours` + - Features: Pagination, total hours, total hours for page, period, SPFR (user by default). + - Redirects: `User name` -> `/stats 'User name'`. + +3. `/top_games` Gives information about most played games. + - Output: `Game name, spent hours` (NB: spent hours by all players) + - Features: Pagination, total hours, total hours for page, period, SPFR (No default, optional) + - Redirects: `Game name` -> `/top_players 'Game name'`. + +4. `/game_sessions ((