diff --git a/README.md b/README.md index 0ba3673..0bbfe38 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,21 @@ little desktop buddy for your computer currently just kind of sits and wanders around -you can right click to catmode +## configuration -config is in `~/.config/funfriend/` or `%AppData%/funfriend/` or `~/Library/Application Support/funfriend` +config location depends on your OS: + +| | | +| - | - | +| Windows | `%AppData%/funfriend/` | +| OSX | `~/Library/Application Support/funfriend/` | +| Linux | `~/.config/funfriend/` | + +inside you'll find `cfg.ini`. most keys should be self-explanatory, but here's a few notable ones + +### `buddies.types` + +comma-seperated types of buddies to add, ex. `funfriend,funfriend,god` for 2 funfriends and 1 god. pass in something invalid to print out a list of valid options ## installation