diff --git a/README.md b/README.md index 2b1653d..1dffdc8 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ or LSF Served Fabulously +Options: + -c, --session-cache-dir path to where the session tokens are cached (default "/Users/agent/Library/Caches/go-lsf/sessions") + -u, --username username to login with + +Commands: + grades view your grades + +If you log into lsf using this tool, the session will be cached, so further logins in the near future won't require a new password prompt or login. The session will expire after a few minutes though, even if kept active! + +If you want to run this tool completely noninteractively, create `$HOME/.config/lsfshuttefuckup/credentials` with mod `600` and the contents: `password=mega soopa doopa keewl`. Add nothing else to that file, just this line. + ## TODO - documentation