Skip to content

Commit 4d7bcdc

Browse files
committed
Updated README
1 parent 7b73fa6 commit 4d7bcdc

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ It is designed for reliability, minimal resource usage, and straightforward depl
1111
- Single-container deployment with Docker
1212
- Strictly validated configuration
1313
- Multiple Users supported
14+
- Fetch timetables for specific classes, rooms, teachers, or subjects by name or numeric ID
1415

1516
## Quick Start
1617

@@ -63,14 +64,27 @@ The service requires a JSON configuration file.
6364

6465
## Usage
6566

66-
Once running, the service exposes an `.ics` feed:
67+
### Personal timetable
6768

6869
```
6970
http://<host>:7464/timetable/friendlyName.ics
70-
7171
```
7272

73-
friendlyName represents the one specified in the user configuration. This link can be subscribed to any calendar client and just works out of the box.
73+
`<friendlyName>` is the one specified in the user configuration
74+
Returns the personal timetable as an .ics feed
75+
76+
### Specific element timetable (class, room, teacher, subject)
77+
78+
`<type>`: `"class"`, `"room"`, `"teacher"`, or `"subject"`
79+
`<id>` Either the numeric ID or the name of the element (the service will resolve the name automatically)
80+
81+
Example URLs:
82+
83+
`http://localhost:7464/timetable/jonte/class/12`
84+
`http://localhost:7464/timetable/jonte/room/24`
85+
`http://localhost:7464/timetable/jonte/teacher/MrSmith`
86+
87+
If the ID cannot be resolved, the service will attempt to use it as a numeric ID.
7488

7589
## Contributing
7690

0 commit comments

Comments
 (0)