Simple readme

This commit is contained in:
Lizzy Hunt 2023-02-16 14:07:18 -07:00
parent 312af9bc10
commit 3fca1d7623
No known key found for this signature in database
GPG Key ID: 8AC6A4B840C0EC49

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# AggietimeD
AggietimeD is a simple daemon service written in 2.5 days to do some hacked CAS authentication,
then sit in the background, refreshing the AggieTime JWT periodically to ensure the session
doesn't expire, and listen to requests over a unix socket, making it easy to write scripts to
get Aggie Time data wherever you need it!
## Installation
Something among the lines of:
```
git clone https://github.com/Simponic/aggietime-cli
cd aggietime-cli
npm i
sudo npm install -g .
cp .env.example .env
chmod 0700 .env
```
Then, set your A-Number and password in `.env`.
Finally (optional), change the values in `aggietimed.service` and install it in
`~/.config/systemd/user`, and enable it with
`systemctl --user daemon-reload && systemctl enable --now --user aggietimed`.
## Usage
Look at `aggietimed -h`.