Skip to content

Commit 5cfb7fa

Browse files
authored
Enhance README with quick start and usage examples
Added quick start section with installation and usage examples for adding profiles and listing grades.
1 parent baf4838 commit 5cfb7fa

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Classeviva is a Go library and CLI tool to access the popular school portal https://web.spaggiari.eu.
44

5-
## Install
5+
## Quick Start
6+
7+
### Install
68

79
```sh
810
brew install zmoog/homebrew-classeviva/classeviva
@@ -24,6 +26,33 @@ classeviva
2426
classeviva (Binary)
2527
```
2628

29+
### Add your kids
30+
31+
```sh
32+
$ classeviva profile add joelmiller
33+
Username: joelmiller
34+
Password: ******
35+
Profile 'joelmiller' added successfully.
36+
```
37+
38+
```sh
39+
$ classeviva profile list
40+
+------------+------------+---------+
41+
| PROFILE | USERNAME | DEFAULT |
42+
+------------+------------+---------+
43+
| joelmiller | joelmiller | * |
44+
+------------+------------+---------+
45+
46+
$ classeviva grades list
47+
+------------+-------+-----------------------------------------------------------+----------------------------------+
48+
| DATE | GRADE | SUBJECT | NOTES |
49+
+------------+-------+-----------------------------------------------------------+----------------------------------+
50+
| 2025-10-24 | 9 | SCIENZE MOTORIE E SPORTIVE | |
51+
| | 7- | STORIA | |
52+
| 2025-10-22 || SCIENZE NATURALI (BIOLOGIA, CHIMICA, SCIENZE DELLA TERRA) | Verifiche genetica moderna e DNA |
53+
+------------+-------+-----------------------------------------------------------+----------------------------------+%
54+
```
55+
2756
## Authentication
2857

2958
Classeviva supports multiple authentication methods with a priority chain, making it easy to manage credentials for multiple students.

0 commit comments

Comments
 (0)